Package 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("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	Description
static interface	InventoryFilter.Builder

Method Summary

Modifier and Type	Method	Description
static InventoryFilter.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 name of the filter key.
List<SdkField<?>>	sdkFields()
static Class<? extends InventoryFilter.Builder>	serializableBuilderClass()
InventoryFilter.Builder	toBuilder()
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

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

Returns:

The name of the filter key.

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

Inventory filter values. Example: inventory filter where managed node 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.

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:

Inventory filter values. Example: inventory filter where managed node 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Systems Manager User Guide.

See Also:

InventoryQueryOperatorType

toBuilder

public InventoryFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InventoryFilter.Builder,InventoryFilter>

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)

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