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 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 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 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 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.
`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 secret value, if the secret value was originally provided as binary data in the form of a byte array.
`GetSecretValueResult`	`withSecretString(String secretString)` The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
`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 secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    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 secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
  - getSecretBinary
```
public ByteBuffer getSecretBinary()
```
    The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    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 secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
  - withSecretBinary
```
public GetSecretValueResult withSecretBinary(ByteBuffer secretBinary)
```
    The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    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 secret value, if the secret value was originally provided as binary data in the form of a byte array. When you retrieve a SecretBinary using the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not encoded.
    
    If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString instead.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecretString
```
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.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    Parameters:
    
    secretString - The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
  - getSecretString
```
public String getSecretString()
```
    The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    Returns:
    
    The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
  - withSecretString
```
public GetSecretValueResult withSecretString(String secretString)
```
    The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    Parameters:
    
    secretString - The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
    
    If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
    
    Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
    
    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. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
    
    Parameters:
    
    createdDate - The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
    
    Returns:
    
    The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
  - withCreatedDate
```
public GetSecretValueResult withCreatedDate(Date createdDate)
```
    The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
    
    Parameters:
    
    createdDate - The date and time that this version of the secret was created. If you don't specify which version in VersionId or VersionStage, then Secrets Manager uses the AWSCURRENT version.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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

AWS SDK for Java 1.x API Reference - 1.12.779

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