GetSecretValueResult

java.lang.Object
- com.amazonaws.greengrass.javasdk.model.GetSecretValueResult

public class GetSecretValueResult
extends Object

Result for getting a secret value.

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
`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.
`void`	`setARN(String inputArn)` 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.
`GetSecretValueResult`	`withARN(String inputARN)` The ARN of the secret.
`GetSecretValueResult`	`withCreatedDate(Date inputCreatedDate)` The date and time that this version of the secret was created.
`GetSecretValueResult`	`withName(String inputName)` The friendly name of the secret.
`GetSecretValueResult`	`withSecretBinary(ByteBuffer inputSecretBinary)` 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 inputSecretString)` The decrypted part of the protected secret information that was originally provided as a string.
`GetSecretValueResult`	`withVersionId(String inputVersionId)` The unique identifier of this version of the secret.
`GetSecretValueResult`	`withVersionStages(Collection<String> inputVersionStages)` A list of all of the staging labels currently attached to this version of the secret.
`GetSecretValueResult`	`withVersionStages(String... inputVersionStage)` A list of all of the staging labels currently attached to this version of the secret.

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

- Constructor Detail
  - GetSecretValueResult
```
public GetSecretValueResult()
```
- Method Detail
  - getARN
```
public String getARN()
```
    The ARN of the secret.
    
    Returns:
    
    The ARN of the secret.
  - setARN
```
public void setARN(String inputArn)
```
    The ARN of the secret.
    
    Parameters:
    
    inputArn - The ARN of the secret.
  - 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.
  - 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.
  - getName
```
public String getName()
```
    The friendly name of the secret.
    
    Returns:
    
    The friendly name of the secret.
  - setName
```
public void setName(String name)
```
    The friendly name of the secret.
    
    Parameters:
    
    name - The friendly name of the secret.
  - 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.
  - 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.
    
    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.
  - 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.
  - 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 ust 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.
  - getVersionId
```
public String getVersionId()
```
    The unique identifier of this version of the secret.
    
    Returns:
    
    The unique identifier of this version of the secret.
  - 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.
  - 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.
  - withARN
```
public GetSecretValueResult withARN(String inputARN)
```
    The ARN of the secret.
    
    Parameters:
    
    inputARN - The ARN of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCreatedDate
```
public GetSecretValueResult withCreatedDate(Date inputCreatedDate)
```
    The date and time that this version of the secret was created.
    
    Parameters:
    
    inputCreatedDate - 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.
  - withName
```
public GetSecretValueResult withName(String inputName)
```
    The friendly name of the secret.
    
    Parameters:
    
    inputName - The friendly name of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSecretBinary
```
public GetSecretValueResult withSecretBinary(ByteBuffer inputSecretBinary)
```
    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:
    
    inputSecretBinary - 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.
  - withSecretString
```
public GetSecretValueResult withSecretString(String inputSecretString)
```
    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:
    
    inputSecretString - 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.
  - withVersionId
```
public GetSecretValueResult withVersionId(String inputVersionId)
```
    The unique identifier of this version of the secret.
    
    Parameters:
    
    inputVersionId - The unique identifier of 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> inputVersionStages)
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Parameters:
    
    inputVersionStages - 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(String... inputVersionStage)
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Parameters:
    
    inputVersionStage - 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.

Class GetSecretValueResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetSecretValueResult

Method Detail

getARN

setARN

getCreatedDate

setCreatedDate

getName

setName

getSecretBinary

setSecretBinary

getSecretString

setSecretString

getVersionId

setVersionId

getVersionStages

setVersionStages

withARN

withCreatedDate

withName

withSecretBinary

withSecretString

withVersionId

withVersionStages

withVersionStages