Vault (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.keymanagement.model.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).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Vault.Builder`
`static class`	`Vault.LifecycleState` The vault’s current lifecycle state.
`static class`	`Vault.VaultType` The type of vault.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
Vault(String compartmentId, String cryptoEndpoint, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, Vault.LifecycleState lifecycleState, String managementEndpoint, Date timeCreated, Date timeOfDeletion, Vault.VaultType vaultType, String restoredFromVaultId, String wrappingkeyId, VaultReplicaDetails replicaDetails, Boolean isPrimary, Boolean isVaultReplicable, ExternalKeyManagerMetadataSummary externalKeyManagerMetadataSummary) Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Vault.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment that contains this vault.
`String`	`getCryptoEndpoint()` The service endpoint to perform cryptographic operations against.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user-friendly name for the vault.
`ExternalKeyManagerMetadataSummary`	`getExternalKeyManagerMetadataSummary()`
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the vault.
`Boolean`	`getIsPrimary()` A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
`Boolean`	`getIsVaultReplicable()` A Boolean value that indicates whether the Vault has cross region replication capability.
`Vault.LifecycleState`	`getLifecycleState()` The vault’s current lifecycle state.
`String`	`getManagementEndpoint()` The service endpoint to perform management operations against.
`VaultReplicaDetails`	`getReplicaDetails()`
`String`	`getRestoredFromVaultId()` The OCID of the vault from which this vault was restored, if it was restored from a backup file.
`Date`	`getTimeCreated()` The date and time this vault was created, expressed in RFC 3339 timestamp format.
`Date`	`getTimeOfDeletion()` An optional property to indicate when to delete the vault, expressed in RFC 3339 timestamp format.
`Vault.VaultType`	`getVaultType()` The type of vault.
`String`	`getWrappingkeyId()` The OCID of the vault’s wrapping key.
`int`	`hashCode()`
`Vault.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Vault

@Deprecated
 @ConstructorProperties(value={"compartmentId","cryptoEndpoint","definedTags","displayName","freeformTags","id","lifecycleState","managementEndpoint","timeCreated","timeOfDeletion","vaultType","restoredFromVaultId","wrappingkeyId","replicaDetails","isPrimary","isVaultReplicable","externalKeyManagerMetadataSummary"})
public Vault(String compartmentId,
                                                                                                                                                                                                                                                                                                                                                       String cryptoEndpoint,
                                                                                                                                                                                                                                                                                                                                                       Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                                                       String displayName,
                                                                                                                                                                                                                                                                                                                                                       Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                                                       String id,
                                                                                                                                                                                                                                                                                                                                                       Vault.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                                                       String managementEndpoint,
                                                                                                                                                                                                                                                                                                                                                       Date timeCreated,
                                                                                                                                                                                                                                                                                                                                                       Date timeOfDeletion,
                                                                                                                                                                                                                                                                                                                                                       Vault.VaultType vaultType,
                                                                                                                                                                                                                                                                                                                                                       String restoredFromVaultId,
                                                                                                                                                                                                                                                                                                                                                       String wrappingkeyId,
                                                                                                                                                                                                                                                                                                                                                       VaultReplicaDetails replicaDetails,
                                                                                                                                                                                                                                                                                                                                                       Boolean isPrimary,
                                                                                                                                                                                                                                                                                                                                                       Boolean isVaultReplicable,
                                                                                                                                                                                                                                                                                                                                                       ExternalKeyManagerMetadataSummary externalKeyManagerMetadataSummary)

Deprecated.

Method Detail
- builder
```
public static Vault.Builder builder()
```
  Create a new builder.
- toBuilder
```
public Vault.Builder toBuilder()
```
- 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
- getReplicaDetails
```
public VaultReplicaDetails getReplicaDetails()
```
- 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
- getExternalKeyManagerMetadataSummary
```
public ExternalKeyManagerMetadataSummary getExternalKeyManagerMetadataSummary()
```
- 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

Class Vault

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Vault

Method Detail

builder

toBuilder

getCompartmentId

getCryptoEndpoint

getDefinedTags

getDisplayName

getFreeformTags

getId

getLifecycleState

getManagementEndpoint

getTimeCreated

getTimeOfDeletion

getVaultType

getRestoredFromVaultId

getWrappingkeyId

getReplicaDetails

getIsPrimary

getIsVaultReplicable

getExternalKeyManagerMetadataSummary

toString

toString

equals

hashCode