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

Class PatchFilter

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

Defines which patches should be included in a patch baseline.

A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY.

The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are ["Office 2013", "Office 2016"], then the filter accepts all patches where product name is either "Office 2013" or "Office 2016". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.

You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.

See Also:

  • Method Details

    • key

      public final PatchFilterKey key()

      The key for the filter.

      Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

      If the service returns an enum value that is not available in the current SDK version, key will return PatchFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

      Returns:
      The key for the filter.

      Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

      See Also:

    • keyAsString

      public final String keyAsString()

      The key for the filter.

      Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

      If the service returns an enum value that is not available in the current SDK version, key will return PatchFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

      Returns:
      The key for the filter.

      Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

      See Also:

    • 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 for the filter key.

      Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

      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 for the filter key.

      Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

    • toBuilder

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

    • builder

      public static PatchFilter.Builder builder()

    • serializableBuilderClass

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