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()
      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<GetParameterRequest.Builder,GetParameterRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • 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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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