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

Class ParameterStringFilter

java.lang.Object
software.amazon.awssdk.services.ssm.model.ParameterStringFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
@Generated("software.amazon.awssdk:codegen") public final class ParameterStringFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>

One or more filters. Use a filter to return a more specific list of results.

See Also:

  • Method Details

    • key

      public final String key()

      The name of the filter.

      The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.

      For DescribeParameters, all of the listed patterns are valid except Label.

      For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier.

      For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

      Returns:
      The name of the filter.

      The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed for Key can be used with both operations.

      For DescribeParameters, all of the listed patterns are valid except Label.

      For GetParametersByPath, the following patterns listed for Key aren't valid: tag, DataType, Name, Path, and Tier.

      For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

    • option

      public final String option()

      For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

      For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

      Returns:
      For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

      For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using Label as the Key name, the only valid option is Equals.)

    • hasValues

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

    • values

      public final List<String> values()

      The value you want to search for.

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

      Returns:
      The value you want to search for.

    • toBuilder

      public ParameterStringFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>

    • builder

      public static ParameterStringFilter.Builder builder()

    • serializableBuilderClass

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

    • 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