Package com.oracle.bmc.vault.model

Class Secret

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public final class Secret
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of the secret.

    Secret details do not contain the contents of the secret itself.
    Note: Objects should always be created or deserialized using the Secret.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 Secret.Builder, which maintain a set of all explicitly set fields called Secret.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 Secret.Builder builder()
        Create a new builder.

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where you want to create the secret.
        Returns:
        the value

      • getCurrentVersionNumber

        public Long getCurrentVersionNumber()
        The version number of the secret version that’s currently in use.
        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

      • getDescription

        public String getDescription()
        A brief description of the secret.

        Avoid entering confidential 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

      • getId

        public String getId()
        The OCID of the secret.
        Returns:
        the value

      • getKeyId

        public String getKeyId()
        The OCID of the master encryption key that is used to encrypt the secret.

        You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycle state of the secret.
        Returns:
        the value

      • getLifecycleState

        public Secret.LifecycleState getLifecycleState()
        The current lifecycle state of the secret.
        Returns:
        the value

      • getMetadata

        public Map<String,​Object> getMetadata()
        Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks.

        For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

        Returns:
        the value

      • getIsReplica

        public Boolean getIsReplica()
        A Boolean value that indicates whether the secret is a source or replica secret.
        Returns:
        the value

      • getRotationStatus

        public Secret.RotationStatus getRotationStatus()
        Additional information about the status of the secret rotation
        Returns:
        the value

      • getLastRotationTime

        public Date getLastRotationTime()
        A property indicating when the secret was last rotated successfully, expressed in RFC 3339 timestamp format.

        Example: 2019-04-03T21:10:29.600Z

        Returns:
        the value

      • getNextRotationTime

        public Date getNextRotationTime()
        A property indicating when the secret is scheduled to be rotated, expressed in RFC 3339 timestamp format.

        Example: 2019-04-03T21:10:29.600Z

        Returns:
        the value

      • getSecretName

        public String getSecretName()
        The user-friendly name of the secret.

        Avoid entering confidential information.

        Returns:
        the value

      • getSecretRules

        public List<SecretRule> getSecretRules()
        A list of rules that control how the secret is used and managed.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        A property indicating when the secret was created, expressed in RFC 3339 timestamp format.

        Example: 2019-04-03T21:10:29.600Z

        Returns:
        the value

      • getTimeOfCurrentVersionExpiry

        public Date getTimeOfCurrentVersionExpiry()
        An optional property indicating when the current secret version will expire, expressed in RFC 3339 timestamp format.

        Example: 2019-04-03T21:10:29.600Z

        Returns:
        the value

      • getTimeOfDeletion

        public Date getTimeOfDeletion()
        An optional property indicating when to delete the secret, expressed in RFC 3339 timestamp format.

        Example: 2019-04-03T21:10:29.600Z

        Returns:
        the value

      • getVaultId

        public String getVaultId()
        The OCID of the vault where the secret exists.
        Returns:
        the value

      • getIsAutoGenerationEnabled

        public Boolean getIsAutoGenerationEnabled()
        The value of this flag determines whether or not secret content will be generated automatically.
        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