@Generated(value="software.amazon.awssdk:codegen") public final class GetSecretValueResponse extends SecretsManagerResponse implements ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetSecretValueResponse.Builder |
| 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()
For responses, this returns true if the service returned a value for the VersionStages property.
|
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.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The ARN of the secret.
public final String name()
The friendly name of the secret.
public final String versionId()
The unique identifier of this version of the secret.
public final 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.
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.
public final 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.
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.
public final boolean hasVersionStages()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVersionStages() method.
public final Instant createdDate()
The date and time that this version of the secret was created.
public GetSecretValueResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>toBuilder in class AwsResponsepublic static GetSecretValueResponse.Builder builder()
public static Class<? extends GetSecretValueResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2021. All rights reserved.