Package software.amazon.awssdk.services.secretsmanager.model

Class GetSecretValueResponse

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("software.amazon.awssdk:codegen")
public final class GetSecretValueResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSecretValueResponse.Builder

Method Summary

Modifier and Type	Method	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 secret value, if the secret value was originally provided as binary data in the form of a byte array.
String	secretString()	The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
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 final String arn()

The ARN of the secret.

Returns:

The ARN of the secret.

name

public final String name()

The friendly name of the secret.

Returns:

The friendly name of the secret.

versionId

public final String versionId()

The unique identifier of this version of the secret.

Returns:

The unique identifier of this version of the secret.

secretBinary

public final SdkBytes 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.

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.

secretString

public final 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.

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.

hasVersionStages

public final boolean hasVersionStages()

For responses, this returns true if the service returned a value for the VersionStages property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

versionStages

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.

Returns:

A list of all of the staging labels currently attached to this version of the secret.

createdDate

public final Instant 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:

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.

toBuilder

public GetSecretValueResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSecretValueResponse.Builder,GetSecretValueResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSecretValueResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSecretValueResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo