GetSecretValueResponse (AWS Java SDK :: Services :: AWS Secrets Manager 2.15.46 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse
    - - software.amazon.awssdk.services.secretsmanager.model.GetSecretValueResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSecretValueResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetSecretValueResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetSecretValueResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the secret.
`static GetSecretValueResponse.Builder`	`builder()`
`Instant`	`createdDate()` The date and time that this version of the secret was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasVersionStages()` Returns true if the VersionStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`name()` The friendly name of the secret.
`List<SdkField<?>>`	`sdkFields()`
`SdkBytes`	`secretBinary()` The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array.
`String`	`secretString()` The decrypted part of the protected secret information that was originally provided as a string.
`static Class<? extends GetSecretValueResponse.Builder>`	`serializableBuilderClass()`
`GetSecretValueResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`versionId()` The unique identifier of this version of the secret.
`List<String>`	`versionStages()` A list of all of the staging labels currently attached to this version of the secret.

Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public String arn()
```
    The ARN of the secret.
    
    Returns:
    
    The ARN of the secret.
  - name
```
public String name()
```
    The friendly name of the secret.
    
    Returns:
    
    The friendly name of the secret.
  - versionId
```
public String versionId()
```
    The unique identifier of this version of the secret.
    
    Returns:
    
    The unique identifier of this version of the secret.
  - secretBinary
```
public SdkBytes 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:
    
    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.
  - secretString
```
public 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.
    
    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.
  - hasVersionStages
```
public boolean hasVersionStages()
```
    Returns true if the VersionStages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - versionStages
```
public List<String> versionStages()
```
    A list of all of the staging labels currently attached to this version of the secret.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasVersionStages() to see if a value was sent in this field.
    
    Returns:
    
    A list of all of the staging labels currently attached to this version of the secret.
  - createdDate
```
public Instant createdDate()
```
    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.
  - toBuilder
```
public GetSecretValueResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetSecretValueResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetSecretValueResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetSecretValueResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

name

versionId

secretBinary

secretString

hasVersionStages

versionStages

createdDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields