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(value="software.amazon.awssdk:codegen")
public final class InstancePatchStateFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstancePatchStateFilter.Builder,InstancePatchStateFilter>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstancePatchStateFilter.Builder

Method Summary

Modifier and Type	Method and Description
static InstancePatchStateFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	key() The key for the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends InstancePatchStateFilter.Builder>	serializableBuilderClass()
InstancePatchStateFilter.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
InstancePatchStateOperatorType	type() The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
String	typeAsString() The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.
List<String>	values() The value for the filter, must be an integer greater than or equal to 0.

Methods inherited from class java.lang.Object

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 are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

Returns:

The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasValues() to see if a value was sent in this field.

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: Equal, NotEqual, LessThan or GreaterThan.

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: Equal, NotEqual, LessThan or GreaterThan.

See Also:

InstancePatchStateOperatorType

typeAsString

public final String typeAsString()

The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

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: Equal, NotEqual, LessThan or GreaterThan.

See Also:

InstancePatchStateOperatorType

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.