Package com.oracle.bmc.keymanagement.model

Class Vault

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public final class Vault
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The logical entity where the Vault service creates and durably stores keys.
    Note: Objects should always be created or deserialized using the Vault.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 Vault.Builder, which maintain a set of all explicitly set fields called Vault.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 Vault.Builder builder()
        Create a new builder.

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains this vault.
        Returns:
        the value

      • getCryptoEndpoint

        public String getCryptoEndpoint()
        The service endpoint to perform cryptographic operations against.

        Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.

        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

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the vault.

        It does not have to be unique, and it is changeable. 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 vault.
        Returns:
        the value

      • getLifecycleState

        public Vault.LifecycleState getLifecycleState()
        The vault’s current lifecycle state.

        Example: DELETED

        Returns:
        the value

      • getManagementEndpoint

        public String getManagementEndpoint()
        The service endpoint to perform management operations against.

        Management operations include “Create,” “Update,” “List,” “Get,” and “Delete” operations.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time this vault was created, expressed in RFC 3339 timestamp format.

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

        Returns:
        the value

      • getTimeOfDeletion

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

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

        Returns:
        the value

      • getVaultType

        public Vault.VaultType getVaultType()
        The type of vault.

        Each type of vault stores the key with different degrees of isolation and has different options and pricing.

        Returns:
        the value

      • getRestoredFromVaultId

        public String getRestoredFromVaultId()
        The OCID of the vault from which this vault was restored, if it was restored from a backup file.

        If you restore a vault to the same region, the vault retains the same OCID that it had when you backed up the vault.

        Returns:
        the value

      • getWrappingkeyId

        public String getWrappingkeyId()
        The OCID of the vault’s wrapping key.
        Returns:
        the value

      • getIsPrimary

        public Boolean getIsPrimary()
        A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
        Returns:
        the value

      • getIsVaultReplicable

        public Boolean getIsVaultReplicable()
        A Boolean value that indicates whether the Vault has cross region replication capability.

        Always true for Virtual Private Vaults.

        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