Package com.oracle.bmc.pss.model

Class Instance

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20260831")
public final class Instance
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A Public Safety and Security instance.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the Instance.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 Instance.Builder, which maintain a set of all explicitly set fields called Instance.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()
        The OCID of the Instance.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getIdentityDomainUrl

        public String getIdentityDomainUrl()
        The URL of the identity domain associated with the instance.

        Example: https://idcs-1234567890.identity.oraclecloud.com

        Returns:
        the value

      • getIdentityDomainWebAuthClientId

        public String getIdentityDomainWebAuthClientId()
        The client ID of the identity-domain confidential application used for browser authentication.
        Returns:
        the value

      • getIdentityDomainWebAuthClientSecretVaultId

        public String getIdentityDomainWebAuthClientSecretVaultId()
        The OCID of the Vault secret containing the identity-domain confidential application’s client secret.
        Returns:
        the value

      • getAdminIdentityDomainUserId

        public String getAdminIdentityDomainUserId()
        The OCID of the identity-domain user that initially administers the PSS instance.
        Returns:
        the value

      • getPublicIp

        public String getPublicIp()
        The public IP address for the instance’s API gateway.
        Returns:
        the value

      • getServiceEndpoint

        public String getServiceEndpoint()
        The HTTPS endpoint for the instance’s PSS API.

        Example: https://example.pss.oraclecloud.com/api/

        Returns:
        the value

      • getUiEndpoint

        public String getUiEndpoint()
        The HTTPS endpoint for the instance’s PSS user interface.

        Example: https://example.pss.oraclecloud.com/ui/

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the Instance was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

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

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

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

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the Instance in more detail.

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

        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": {"example-key": "example-value"}}

        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