@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SecretValueEntry extends Object implements Serializable, Cloneable, StructuredPojo
A structure that contains the secret value and other details for a secret.
Constructor and Description |
---|
SecretValueEntry() |
Modifier and Type | Method and Description |
---|---|
SecretValueEntry |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the secret.
|
Date |
getCreatedDate()
The date the secret was created.
|
String |
getName()
The friendly name of the secret.
|
ByteBuffer |
getSecretBinary()
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte
array.
|
String |
getSecretString()
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
Manager console.
|
String |
getVersionId()
The unique version identifier of this version of the secret.
|
List<String> |
getVersionStages()
A list of all of the staging labels currently attached to this version of the secret.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
|
void |
setCreatedDate(Date createdDate)
The date the secret was created.
|
void |
setName(String name)
The friendly name of the secret.
|
void |
setSecretBinary(ByteBuffer secretBinary)
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte
array.
|
void |
setSecretString(String secretString)
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
Manager console.
|
void |
setVersionId(String versionId)
The unique version identifier of this version of the secret.
|
void |
setVersionStages(Collection<String> versionStages)
A list of all of the staging labels currently attached to this version of the secret.
|
String |
toString()
Returns a string representation of this object.
|
SecretValueEntry |
withARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
|
SecretValueEntry |
withCreatedDate(Date createdDate)
The date the secret was created.
|
SecretValueEntry |
withName(String name)
The friendly name of the secret.
|
SecretValueEntry |
withSecretBinary(ByteBuffer secretBinary)
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte
array.
|
SecretValueEntry |
withSecretString(String secretString)
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
Manager console.
|
SecretValueEntry |
withVersionId(String versionId)
The unique version identifier of this version of the secret.
|
SecretValueEntry |
withVersionStages(Collection<String> versionStages)
A list of all of the staging labels currently attached to this version of the secret.
|
SecretValueEntry |
withVersionStages(String... versionStages)
A list of all of the staging labels currently attached to this version of the secret.
|
public void setARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
aRN
- The Amazon Resource Name (ARN) of the secret.public String getARN()
The Amazon Resource Name (ARN) of the secret.
public SecretValueEntry withARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
aRN
- The Amazon Resource Name (ARN) of the secret.public void setName(String name)
The friendly name of the secret.
name
- The friendly name of the secret.public String getName()
The friendly name of the secret.
public SecretValueEntry withName(String name)
The friendly name of the secret.
name
- The friendly name of the secret.public void setVersionId(String versionId)
The unique version identifier of this version of the secret.
versionId
- The unique version identifier of this version of the secret.public String getVersionId()
The unique version identifier of this version of the secret.
public SecretValueEntry withVersionId(String versionId)
The unique version identifier of this version of the secret.
versionId
- The unique version identifier of this version of the secret.public void setSecretBinary(ByteBuffer secretBinary)
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
secretBinary
- The decrypted secret value, if the secret value was originally provided as binary data in the form of a
byte array. The parameter represents the binary data as a base64-encoded string.public ByteBuffer getSecretBinary()
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
ByteBuffer
s are stateful. Calling their get
methods changes their position
. We recommend
using ByteBuffer.asReadOnlyBuffer()
to create a read-only view of the buffer with an independent
position
, and calling get
methods on this rather than directly on the returned ByteBuffer
.
Doing so will ensure that anyone else using the ByteBuffer
will not be affected by changes to the
position
.
public SecretValueEntry withSecretBinary(ByteBuffer secretBinary)
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.
The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.
secretBinary
- The decrypted secret value, if the secret value was originally provided as binary data in the form of a
byte array. The parameter represents the binary data as a base64-encoded string.public void setSecretString(String secretString)
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
secretString
- The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
Manager console.public String getSecretString()
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
public SecretValueEntry withSecretString(String secretString)
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
secretString
- The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
Manager console.public List<String> getVersionStages()
A list of all of the staging labels currently attached to this version of the secret.
public void setVersionStages(Collection<String> versionStages)
A list of all of the staging labels currently attached to this version of the secret.
versionStages
- A list of all of the staging labels currently attached to this version of the secret.public SecretValueEntry withVersionStages(String... versionStages)
A list of all of the staging labels currently attached to this version of the secret.
NOTE: This method appends the values to the existing list (if any). Use
setVersionStages(java.util.Collection)
or withVersionStages(java.util.Collection)
if you want
to override the existing values.
versionStages
- A list of all of the staging labels currently attached to this version of the secret.public SecretValueEntry withVersionStages(Collection<String> versionStages)
A list of all of the staging labels currently attached to this version of the secret.
versionStages
- A list of all of the staging labels currently attached to this version of the secret.public void setCreatedDate(Date createdDate)
The date the secret was created.
createdDate
- The date the secret was created.public Date getCreatedDate()
The date the secret was created.
public SecretValueEntry withCreatedDate(Date createdDate)
The date the secret was created.
createdDate
- The date the secret was created.public String toString()
toString
in class Object
Object.toString()
public SecretValueEntry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.