com.oracle.bmc.generativeai.model

Class DedicatedAiCluster

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeai.model.DedicatedAiCluster

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class DedicatedAiCluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Dedicated AI clusters are compute resources that you can use for fine-tuning custom models or for hosting endpoints for custom models. The clusters are dedicated to your models and not shared with users in other tenancies.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resouces](https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
Note: Objects should always be created or deserialized using the DedicatedAiCluster.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DedicatedAiCluster.Builder, which maintain a set of all explicitly set fields called DedicatedAiCluster.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DedicatedAiCluster.Builder
static class	DedicatedAiCluster.LifecycleState The current state of the dedicated AI cluster.
static class	DedicatedAiCluster.Type The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
static class	DedicatedAiCluster.UnitShape The shape of dedicated unit in this AI cluster.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description

DedicatedAiCluster(String id, String displayName, String description, DedicatedAiCluster.Type type, String compartmentId, Date timeCreated, Date timeUpdated, DedicatedAiCluster.LifecycleState lifecycleState, String lifecycleDetails, Integer unitCount, DedicatedAiCluster.UnitShape unitShape, DedicatedAiClusterCapacity capacity, DedicatedAiCluster previousState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static DedicatedAiCluster.Builder	builder() Create a new builder.
boolean	equals(Object o)
DedicatedAiClusterCapacity	getCapacity()
String	getCompartmentId() The compartment OCID to create the dedicated AI cluster in.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDescription() An optional description of the dedicated AI cluster.
String	getDisplayName() A user-friendly name.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the dedicated AI cluster.
String	getLifecycleDetails() A message describing the current state with detail that can provide actionable information.
DedicatedAiCluster.LifecycleState	getLifecycleState() The current state of the dedicated AI cluster.
DedicatedAiCluster	getPreviousState()
Map<String,Map<String,Object>>	getSystemTags() System tags for this resource.
Date	getTimeCreated() The date and time the dedicated AI cluster was created, in the format defined by RFC 3339
Date	getTimeUpdated() The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339
DedicatedAiCluster.Type	getType() The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.
Integer	getUnitCount() The number of dedicated units in this AI cluster.
DedicatedAiCluster.UnitShape	getUnitShape() The shape of dedicated unit in this AI cluster.
int	hashCode()
DedicatedAiCluster.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DedicatedAiCluster

@Deprecated
 @ConstructorProperties(value={"id","displayName","description","type","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","unitCount","unitShape","capacity","previousState","freeformTags","definedTags","systemTags"})
public DedicatedAiCluster(String id,
                                                                                                                                                                                                                                                                                            String displayName,
                                                                                                                                                                                                                                                                                            String description,
                                                                                                                                                                                                                                                                                            DedicatedAiCluster.Type type,
                                                                                                                                                                                                                                                                                            String compartmentId,
                                                                                                                                                                                                                                                                                            Date timeCreated,
                                                                                                                                                                                                                                                                                            Date timeUpdated,
                                                                                                                                                                                                                                                                                            DedicatedAiCluster.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                            String lifecycleDetails,
                                                                                                                                                                                                                                                                                            Integer unitCount,
                                                                                                                                                                                                                                                                                            DedicatedAiCluster.UnitShape unitShape,
                                                                                                                                                                                                                                                                                            DedicatedAiClusterCapacity capacity,
                                                                                                                                                                                                                                                                                            DedicatedAiCluster previousState,
                                                                                                                                                                                                                                                                                            Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                            Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static DedicatedAiCluster.Builder builder()

Create a new builder.

toBuilder

public DedicatedAiCluster.Builder toBuilder()

getId

public String getId()

The OCID of the dedicated AI cluster.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable.

Returns:

the value

getDescription

public String getDescription()

An optional description of the dedicated AI cluster.

Returns:

the value

getType

public DedicatedAiCluster.Type getType()

The dedicated AI cluster type indicating whether this is a fine-tuning/training processor or hosting/inference processor.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The compartment OCID to create the dedicated AI cluster in.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the dedicated AI cluster was created, in the format defined by RFC 3339

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the dedicated AI cluster was updated, in the format defined by RFC 3339

Returns:

the value

getLifecycleState

public DedicatedAiCluster.LifecycleState getLifecycleState()

The current state of the dedicated AI cluster.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state with detail that can provide actionable information.

Returns:

the value

getUnitCount

public Integer getUnitCount()

The number of dedicated units in this AI cluster.

Returns:

the value

getUnitShape

public DedicatedAiCluster.UnitShape getUnitShape()

The shape of dedicated unit in this AI cluster. The underlying hardware configuration is hidden from customers.

Returns:

the value

getCapacity

public DedicatedAiClusterCapacity getCapacity()

getPreviousState

public DedicatedAiCluster getPreviousState()

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel