@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Secret.Builder |
static class |
Secret.LifecycleState
The current lifecycle state of the secret.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Secret(String compartmentId,
Long currentVersionNumber,
Map<String,Map<String,Object>> definedTags,
String description,
Map<String,String> freeformTags,
String id,
String keyId,
String lifecycleDetails,
Secret.LifecycleState lifecycleState,
Map<String,Object> metadata,
String secretName,
List<SecretRule> secretRules,
Date timeCreated,
Date timeOfCurrentVersionExpiry,
Date timeOfDeletion,
String vaultId)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Secret.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment where you want to create the secret.
|
Long |
getCurrentVersionNumber()
The version number of the secret version that’s currently in use.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A brief description of the secret.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the secret.
|
String |
getKeyId()
The OCID of the master encryption key that is used to encrypt the secret.
|
String |
getLifecycleDetails()
Additional information about the current lifecycle state of the secret.
|
Secret.LifecycleState |
getLifecycleState()
The current lifecycle state of the secret.
|
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.
|
String |
getSecretName()
The user-friendly name of the secret.
|
List<SecretRule> |
getSecretRules()
A list of rules that control how the secret is used and managed.
|
Date |
getTimeCreated()
A property indicating when the secret was created, expressed in RFC
3339 timestamp format.
|
Date |
getTimeOfCurrentVersionExpiry()
An optional property indicating when the current secret version will expire, expressed in
RFC 3339 timestamp format.
|
Date |
getTimeOfDeletion()
An optional property indicating when to delete the secret, expressed in RFC
3339 timestamp format.
|
String |
getVaultId()
The OCID of the vault where the secret exists.
|
int |
hashCode() |
Secret.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","currentVersionNumber","definedTags","description","freeformTags","id","keyId","lifecycleDetails","lifecycleState","metadata","secretName","secretRules","timeCreated","timeOfCurrentVersionExpiry","timeOfDeletion","vaultId"}) public Secret(String compartmentId, Long currentVersionNumber, Map<String,Map<String,Object>> definedTags, String description, Map<String,String> freeformTags, String id, String keyId, String lifecycleDetails, Secret.LifecycleState lifecycleState, Map<String,Object> metadata, String secretName, List<SecretRule> secretRules, Date timeCreated, Date timeOfCurrentVersionExpiry, Date timeOfDeletion, String vaultId)
public static Secret.Builder builder()
Create a new builder.
public Secret.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment where you want to create the secret.
public Long getCurrentVersionNumber()
The version number of the secret version that’s currently in use.
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"}}
public String getDescription()
A brief description of the secret. Avoid entering confidential information.
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"}
public String getId()
The OCID of the secret.
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.
public String getLifecycleDetails()
Additional information about the current lifecycle state of the secret.
public Secret.LifecycleState getLifecycleState()
The current lifecycle state of the secret.
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.
public String getSecretName()
The user-friendly name of the secret. Avoid entering confidential information.
public List<SecretRule> getSecretRules()
A list of rules that control how the secret is used and managed.
public Date getTimeCreated()
A property indicating when the secret was created, expressed in RFC
3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
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
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
public String getVaultId()
The OCID of the vault where the secret exists.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2023. All rights reserved.