software.amazon.awssdk.services.ssm.model

Class InventoryFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.InventoryFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InventoryFilter.Builder,InventoryFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class InventoryFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InventoryFilter.Builder,InventoryFilter>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InventoryFilter.Builder

Method Summary

Modifier and Type	Method and Description
static InventoryFilter.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 name of the filter key.
List<SdkField<?>>	sdkFields()
static Class<? extends InventoryFilter.Builder>	serializableBuilderClass()
InventoryFilter.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.
InventoryQueryOperatorType	type() The type of filter.
String	typeAsString() The type of filter.
List<String>	values() Inventory filter values.

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

Returns:

The name of the filter key.

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()

Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

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:

Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

type

public final InventoryQueryOperatorType type()

The type of filter.

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.

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

Returns:

The type of filter.

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.

See Also:

InventoryQueryOperatorType

typeAsString

public final String typeAsString()

The type of filter.

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.

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

Returns:

The type of filter.

The Exists filter must be used with aggregators. For more information, see Aggregating inventory data in the AWS Systems Manager User Guide.

See Also:

InventoryQueryOperatorType

toBuilder

public InventoryFilter.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<InventoryFilter.Builder,InventoryFilter>

Returns:

a builder for type T

builder

public static InventoryFilter.Builder builder()

serializableBuilderClass

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