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

Class SecretValueEntry

java.lang.Object

software.amazon.awssdk.services.secretsmanager.model.SecretValueEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SecretValueEntry.Builder,SecretValueEntry>

@Generated("software.amazon.awssdk:codegen")
public final class SecretValueEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SecretValueEntry.Builder,SecretValueEntry>

A structure that contains the secret value and other details for a secret.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecretValueEntry.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the secret.
static SecretValueEntry.Builder	builder()
Instant	createdDate()	The date 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 SecretValueEntry.Builder>	serializableBuilderClass()
SecretValueEntry.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionId()	The unique version 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 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 Amazon Resource Name (ARN) of the secret.

Returns:

The Amazon Resource Name (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 version identifier of this version of the secret.

Returns:

The unique version 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. The parameter represents the binary data as a base64-encoded string.

Returns:

The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The parameter represents the binary data as a base64-encoded string.

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.

Returns:

The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.

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 the secret was created.

Returns:

The date the secret was created.

toBuilder

public SecretValueEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SecretValueEntry.Builder,SecretValueEntry>

builder

public static SecretValueEntry.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo