Package com.oracle.bmc.ailanguage.model

Class Endpoint

java.lang.Object

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

com.oracle.bmc.ailanguage.model.Endpoint

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

Description of the endpoint.
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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Endpoint.Builder
static class	Endpoint.ComputeType	Compute infra type for endpoint.
static class	Endpoint.LifecycleState	The state of the endpoint.

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

Description

Endpoint(String id, String alias, Endpoint.ComputeType computeType, String displayName, String compartmentId, String projectId, String description, Date timeCreated, Date timeUpdated, Endpoint.LifecycleState lifecycleState, String lifecycleDetails, Integer inferenceUnits, String modelId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static Endpoint.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAlias()	Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
String	getCompartmentId()	The OCID for the endpoint compartment.
Endpoint.ComputeType	getComputeType()	Compute infra type for endpoint.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	A short description of the endpoint.
String	getDisplayName()	A user-friendly display name for the resource.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	Unique identifier endpoint OCID of an endpoint that is immutable on creation.
Integer	getInferenceUnits()	Number of replicas required for this endpoint.
String	getLifecycleDetails()	A message describing the current state in more detail.
Endpoint.LifecycleState	getLifecycleState()	The state of the endpoint.
String	getModelId()	The OCID of the model to associate with the endpoint.
String	getProjectId()	The OCID of the project to associate with the Endpoint.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeCreated()	The time the the endpoint was created.
Date	getTimeUpdated()	The time the endpoint was updated.
int	hashCode()
Endpoint.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

Endpoint

@Deprecated
@ConstructorProperties({"id","alias","computeType","displayName","compartmentId","projectId","description","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","inferenceUnits","modelId","freeformTags","definedTags","systemTags"})
public Endpoint(String id,
                String alias,
                Endpoint.ComputeType computeType,
                String displayName,
                String compartmentId,
                String projectId,
                String description,
                Date timeCreated,
                Date timeUpdated,
                Endpoint.LifecycleState lifecycleState,
                String lifecycleDetails,
                Integer inferenceUnits,
                String modelId,
                Map<String,String> freeformTags,
                Map<String,Map<String,Object>> definedTags,
                Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static Endpoint.Builder builder()

Create a new builder.

toBuilder

public Endpoint.Builder toBuilder()

getId

public String getId()

Unique identifier endpoint OCID of an endpoint that is immutable on creation.

Returns:

the value

getAlias

public String getAlias()

Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns:

the value

getComputeType

public Endpoint.ComputeType getComputeType()

Compute infra type for endpoint.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name for the resource.

It should be unique and can be modified. Avoid entering confidential information.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID for the endpoint compartment.

Returns:

the value

getProjectId

public String getProjectId()

The OCID of the project to associate with the Endpoint.

Returns:

the value

getDescription

public String getDescription()

A short description of the endpoint.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the the endpoint was created.

An RFC3339 formatted datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time the endpoint was updated.

An RFC3339 formatted datetime string.

Returns:

the value

getLifecycleState

public Endpoint.LifecycleState getLifecycleState()

The state of the endpoint.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail.

For example, can be used to provide actionable information for a resource in failed state.

Returns:

the value

getInferenceUnits

public Integer getInferenceUnits()

Number of replicas required for this endpoint.

Returns:

the value

getModelId

public String getModelId()

The OCID of the model to associate with the endpoint.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

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

Usage of system tag keys.

These predefined keys are scoped to namespaces. 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