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

Class InstancePatchStateFilter

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

Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API.

Example: To filter for all managed nodes in a patch group having more than three patches with a FailedCount status, use the following for the filter:

  • Value for Key: FailedCount

  • Value for Type: GreaterThan

  • Value for Values: 3

See Also:

  • Method Details

    • key

      public final String key()

      The key for the filter. Supported values include the following:

      • InstalledCount

      • InstalledOtherCount

      • InstalledPendingRebootCount

      • InstalledRejectedCount

      • MissingCount

      • FailedCount

      • UnreportedNotApplicableCount

      • NotApplicableCount

      Returns:
      The key for the filter. Supported values include the following:

      • InstalledCount

      • InstalledOtherCount

      • InstalledPendingRebootCount

      • InstalledRejectedCount

      • MissingCount

      • FailedCount

      • UnreportedNotApplicableCount

      • NotApplicableCount

    • 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. Must be an integer greater than or equal to 0.

      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. Must be an integer greater than or equal to 0.

    • type

      public final InstancePatchStateOperatorType type()

      The type of comparison that should be performed for the value.

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

      Returns:
      The type of comparison that should be performed for the value.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of comparison that should be performed for the value.

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

      Returns:
      The type of comparison that should be performed for the value.
      See Also:

    • toBuilder

      public InstancePatchStateFilter.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<InstancePatchStateFilter.Builder,InstancePatchStateFilter>
      Returns:
      a builder for type T

    • builder

      public static InstancePatchStateFilter.Builder builder()

    • serializableBuilderClass

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

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