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

Class GetSecretValueRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest
software.amazon.awssdk.services.secretsmanager.model.GetSecretValueRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSecretValueRequest extends SecretsManagerRequest implements ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>

  • Method Details

    • secretId

      public final String secretId()

      The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Returns:
      The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

    • versionId

      public final String versionId()

      The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

      This value is typically a UUID-type value with 32 hexadecimal digits.

      Returns:
      The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, then Secrets Manager returns the AWSCURRENT version.

      This value is typically a UUID-type value with 32 hexadecimal digits.

    • versionStage

      public final String versionStage()

      The staging label of the version of the secret to retrieve.

      Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.

      Returns:
      The staging label of the version of the secret to retrieve.

      Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId, the two parameters must refer to the same secret version. If you don't specify either a VersionStage or VersionId, Secrets Manager returns the AWSCURRENT version.

    • toBuilder

      public GetSecretValueRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSecretValueRequest.Builder,GetSecretValueRequest>
      Specified by:
      toBuilder in class SecretsManagerRequest

    • builder

      public static GetSecretValueRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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 SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo