Package com.oracle.bmc.generativeai.model

Class Endpoint

  • @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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) and [Getting Access to Generative AI Resources](https://docs.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).

    • Method Detail

      • getId

        public String getId()
        An OCID that uniquely identifies this endpoint resource.
        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 endpoint.
        Returns:
        the value

      • getModelId

        public String getModelId()
        The OCID of the model that’s used to create this endpoint.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The compartment OCID to create the endpoint in.
        Returns:
        the value

      • getDedicatedAiClusterId

        public String getDedicatedAiClusterId()
        The OCID of the dedicated AI cluster on which the model will be deployed to.
        Returns:
        the value

      • getGenerativeAiPrivateEndpointId

        public String getGenerativeAiPrivateEndpointId()
        The OCID of the Generative AI private endpoint to which this endpoint is attached to.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time that the endpoint was created in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time that the endpoint was updated in the format of an RFC3339 datetime string.
        Returns:
        the value

      • getLifecycleState

        public Endpoint.LifecycleState getLifecycleState()
        The current state of the endpoint.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state of the endpoint in more detail that can provide actionable information.
        Returns:
        the value

      • getPreviousState

        public Endpoint 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