Package com.oracle.bmc.vault.model

Class CreateSecretDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public final class CreateSecretDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of the secret that you want to create.
    Note: Objects should always be created or deserialized using the CreateSecretDetails.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 CreateSecretDetails.Builder, which maintain a set of all explicitly set fields called CreateSecretDetails.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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where you want to create the secret.
        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

      • 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

      • getMetadata

        public Map<String,​Object> getMetadata()
        Additional metadata that you can use to provide context about how to use the secret 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

      • getSecretName

        public String getSecretName()
        A user-friendly name for the secret.

        Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

        Returns:
        the value

      • getSecretRules

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

      • getVaultId

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

      • getEnableAutoGeneration

        public Boolean getEnableAutoGeneration()
        The value of this flag determines whether or not secret content will be generated automatically.

        If not set, it defaults to false.

        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