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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SecretValueEntry.Builder,SecretValueEntry>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.