Package software.amazon.awssdk.services.ssm.model

Class GetParameterRequest

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

  • Method Details

    • name

      public final String name()

      The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

      To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

      For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

      Returns:
      The name or Amazon Resource Name (ARN) of the parameter that you want to query. For parameters shared with you from another account, you must use the full ARN.

      To query by parameter label, use "Name": "name:label". To query by parameter version, use "Name": "name:version".

      For more information about shared parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

    • withDecryption

      public final Boolean withDecryption()

      Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

      Returns:
      Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    • toBuilder

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

    • builder

      public static GetParameterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetParameterRequest.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