GetSecretValueResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.secretsmanager.model.GetSecretValueResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSecretValueResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetSecretValueResult()

Constructors
Constructor and Description
`GetSecretValueResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetSecretValueResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The ARN of the secret.
`Date`	`getCreatedDate()` The date and time that this version of the secret was created.
`String`	`getName()` The friendly name of the secret.
`ByteBuffer`	`getSecretBinary()` The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
`String`	`getSecretString()` The decrypted part of the protected secret information that was originally provided as a string.
`String`	`getVersionId()` The unique 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`	`setARN(String aRN)` The ARN of the secret.
`void`	`setCreatedDate(Date createdDate)` The date and time that this version of the secret was created.
`void`	`setName(String name)` The friendly name of the secret.
`void`	`setSecretBinary(ByteBuffer secretBinary)` The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
`void`	`setSecretString(String secretString)` The decrypted part of the protected secret information that was originally provided as a string.
`void`	`setVersionId(String versionId)` The unique 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; useful for testing and debugging.
`GetSecretValueResult`	`withARN(String aRN)` The ARN of the secret.
`GetSecretValueResult`	`withCreatedDate(Date createdDate)` The date and time that this version of the secret was created.
`GetSecretValueResult`	`withName(String name)` The friendly name of the secret.
`GetSecretValueResult`	`withSecretBinary(ByteBuffer secretBinary)` The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
`GetSecretValueResult`	`withSecretString(String secretString)` The decrypted part of the protected secret information that was originally provided as a string.
`GetSecretValueResult`	`withVersionId(String versionId)` The unique identifier of this version of the secret.
`GetSecretValueResult`	`withVersionStages(Collection<String> versionStages)` A list of all of the staging labels currently attached to this version of the secret.
`GetSecretValueResult`	`withVersionStages(String... versionStages)` A list of all of the staging labels currently attached to this version of the secret.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetSecretValueResult
```
public GetSecretValueResult()
```
- Method Detail
  - setARN
```
public void setARN(String aRN)
```
    The ARN of the secret.
    
    Parameters:
    
    aRN - The ARN of the secret.
  - getARN
```
public String getARN()
```
    The ARN of the secret.
    
    Returns:
    
    The ARN of the secret.
  - withARN
```
public GetSecretValueResult withARN(String aRN)
```
    The ARN of the secret.
    
    Parameters:
    
    aRN - The ARN of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The friendly name of the secret.
    
    Parameters:
    
    name - The friendly name of the secret.
  - getName
```
public String getName()
```
    The friendly name of the secret.
    
    Returns:
    
    The friendly name of the secret.
  - withName
```
public GetSecretValueResult withName(String name)
```
    The friendly name of the secret.
    
    Parameters:
    
    name - The friendly name of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionId
```
public void setVersionId(String versionId)
```
    The unique identifier of this version of the secret.
    
    Parameters:
    
    versionId - The unique identifier of this version of the secret.
  - getVersionId
```
public String getVersionId()
```
    The unique identifier of this version of the secret.
    
    Returns:
    
    The unique identifier of this version of the secret.
  - withVersionId
```
public GetSecretValueResult withVersionId(String versionId)
```
    The unique identifier of this version of the secret.
    
    Parameters:
    
    versionId - The unique identifier of this version of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretBinary
```
public void setSecretBinary(ByteBuffer secretBinary)
```
    The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
    
    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.
    
    Parameters:
    
    secretBinary - The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
  - getSecretBinary
```
public ByteBuffer getSecretBinary()
```
    The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
    
    ByteBuffers 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.
    
    Returns:
    
    The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
  - withSecretBinary
```
public GetSecretValueResult withSecretBinary(ByteBuffer secretBinary)
```
    The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
    
    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.
    
    Parameters:
    
    secretBinary - The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
    
    This parameter is not used if the secret is created by the Secrets Manager console.
    
    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretString
```
public void setSecretString(String secretString)
```
    The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
    
    Parameters:
    
    secretString - The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
  - getSecretString
```
public String getSecretString()
```
    The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
    
    Returns:
    
    The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
  - withSecretString
```
public GetSecretValueResult withSecretString(String secretString)
```
    The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
    
    Parameters:
    
    secretString - The decrypted part of the protected secret information that was originally provided as a string.
    
    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
    
    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVersionStages
```
public List<String> getVersionStages()
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Returns:
    
    A list of all of the staging labels currently attached to this version of the secret.
  - setVersionStages
```
public void setVersionStages(Collection<String> versionStages)
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Parameters:
    
    versionStages - A list of all of the staging labels currently attached to this version of the secret.
  - withVersionStages
```
public GetSecretValueResult 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.
    
    Parameters:
    
    versionStages - A list of all of the staging labels currently attached to this version of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVersionStages
```
public GetSecretValueResult withVersionStages(Collection<String> versionStages)
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Parameters:
    
    versionStages - A list of all of the staging labels currently attached to this version of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date and time that this version of the secret was created.
    
    Parameters:
    
    createdDate - The date and time that this version of the secret was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date and time that this version of the secret was created.
    
    Returns:
    
    The date and time that this version of the secret was created.
  - withCreatedDate
```
public GetSecretValueResult withCreatedDate(Date createdDate)
```
    The date and time that this version of the secret was created.
    
    Parameters:
    
    createdDate - The date and time that this version of the secret was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetSecretValueResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetSecretValueResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetSecretValueResult

Method Detail

setARN

getARN

withARN

setName

getName

withName

setVersionId

getVersionId

withVersionId

setSecretBinary

getSecretBinary

withSecretBinary

setSecretString

getSecretString

withSecretString

getVersionStages

setVersionStages

withVersionStages

withVersionStages

setCreatedDate

getCreatedDate

withCreatedDate

toString

equals

hashCode

clone