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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InstancePatchStateFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InstancePatchStateFilter.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasValues()
For responses, this returns true if the service returned a value for the Values property.String
key()
The key for the filter.List<SdkField<?>>
sdkFields()
static Class<? extends InstancePatchStateFilter.Builder>
serializableBuilderClass()
InstancePatchStateFilter.Builder
toBuilder()
String
toString()
Returns a string representation of this object.InstancePatchStateOperatorType
type()
The type of comparison that should be performed for the value.String
typeAsString()
The type of comparison that should be performed for the value.List<String>
values()
The value for the filter.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()
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 returnInstancePatchStateOperatorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of comparison that should be performed for the value.
- See Also:
InstancePatchStateOperatorType
-
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 returnInstancePatchStateOperatorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of comparison that should be performed for the value.
- See Also:
InstancePatchStateOperatorType
-
toBuilder
public InstancePatchStateFilter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstancePatchStateFilter.Builder,InstancePatchStateFilter>
-
builder
public static InstancePatchStateFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends InstancePatchStateFilter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-