@Generated(value="OracleSDKGenerator",
comments="API Version: 20231130")
public final class Endpoint
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster of type HOSTING.
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
Resources](https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
Note: Objects should always be created or deserialized using the Endpoint.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 Endpoint.Builder, which maintain a
set of all explicitly set fields called Endpoint.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Endpoint.Builder |
static class |
Endpoint.LifecycleState
The current state of the endpoint.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Endpoint(String id,
String displayName,
String description,
String modelId,
String compartmentId,
String dedicatedAiClusterId,
Date timeCreated,
Date timeUpdated,
Endpoint.LifecycleState lifecycleState,
String lifecycleDetails,
ContentModerationConfig contentModerationConfig,
Endpoint previousState,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Endpoint.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The compartment OCID to create the endpoint in.
|
ContentModerationConfig |
getContentModerationConfig() |
String |
getDedicatedAiClusterId()
The OCID of the dedicated AI cluster on which the model will be deployed to.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
An optional description of the endpoint.
|
String |
getDisplayName()
A user-friendly name.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
An OCID that uniquely identifies this endpoint resource.
|
String |
getLifecycleDetails()
A message describing the current state of the endpoint in more detail that can provide
actionable information.
|
Endpoint.LifecycleState |
getLifecycleState()
The current state of the endpoint.
|
String |
getModelId()
The OCID of the model that’s used to create this endpoint.
|
Endpoint |
getPreviousState() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time that the endpoint was created in the format of an RFC3339 datetime string.
|
Date |
getTimeUpdated()
The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
|
int |
hashCode() |
Endpoint.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","description","modelId","compartmentId","dedicatedAiClusterId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","contentModerationConfig","previousState","freeformTags","definedTags","systemTags"}) public Endpoint(String id, String displayName, String description, String modelId, String compartmentId, String dedicatedAiClusterId, Date timeCreated, Date timeUpdated, Endpoint.LifecycleState lifecycleState, String lifecycleDetails, ContentModerationConfig contentModerationConfig, Endpoint previousState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static Endpoint.Builder builder()
Create a new builder.
public Endpoint.Builder toBuilder()
public String getId()
An OCID that uniquely identifies this endpoint resource.
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable.
public String getDescription()
An optional description of the endpoint.
public String getModelId()
The OCID of the model that’s used to create this endpoint.
public String getCompartmentId()
The compartment OCID to create the endpoint in.
public String getDedicatedAiClusterId()
The OCID of the dedicated AI cluster on which the model will be deployed to.
public Date getTimeCreated()
The date and time that the endpoint was created in the format of an RFC3339 datetime string.
public Date getTimeUpdated()
The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
public Endpoint.LifecycleState getLifecycleState()
The current state of the endpoint.
public String getLifecycleDetails()
A message describing the current state of the endpoint in more detail that can provide actionable information.
public ContentModerationConfig getContentModerationConfig()
public Endpoint getPreviousState()
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"}
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"}}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.