Package com.oracle.bmc.generativeai.model

Class ApiKey

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class ApiKey
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    ApiKeys are resources used to access GenAI models.

    You must be authorized through an IAM policy to use any API operations. If you’re not authorized, contact an administrator who manages OCI resource access. See Getting Started with Policies and Getting Access to Generative AI Resources.
    Note: Objects should always be created or deserialized using the ApiKey.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 ApiKey.Builder, which maintain a set of all explicitly set fields called ApiKey.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

      • builder

        public static ApiKey.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        the ApiKey id.
        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 Api key.
        Returns:
        the value

      • getCompartmentId

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

      • getTimeCreated

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

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the ApiKey was updated, in the format defined by RFC 3339.
        Returns:
        the value

      • getKeys

        public List<ApiKeyItem> getKeys()
        The list of keys.
        Returns:
        the value

      • getLifecycleState

        public ApiKey.LifecycleState getLifecycleState()
        The current state of the API key.
        Returns:
        the value

      • getLifecycleDetails

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

      • 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