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

Class GetParametersRequest

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.GetParametersRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetParametersRequest.Builder,GetParametersRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetParametersRequest extends SsmRequest implements ToCopyableBuilder<GetParametersRequest.Builder,GetParametersRequest>

  • Method Details

    • hasNames

      public final boolean hasNames()
      For responses, this returns true if the service returned a value for the Names 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.

    • names

      public final List<String> names()

      The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

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

      The results for GetParameters requests are listed in alphabetical order in query responses.

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

      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 hasNames() method.

      Returns:
      The names or Amazon Resource Names (ARNs) of the parameters that you want to query. For parameters shared with you from another account, you must use the full ARNs.

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

      The results for GetParameters requests are listed in alphabetical order in query responses.

      For 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 secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

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

    • toBuilder

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

    • builder

      public static GetParametersRequest.Builder builder()

    • serializableBuilderClass

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