Package software.amazon.awssdk.services.marketplacecatalog.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.marketplacecatalog.model.Filter

All Implemented Interfaces:

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

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

A filter object, used to optionally filter results from calls to the ListEntities and ListChangeSets actions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method	Description
static Filter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValueList()	For responses, this returns true if the service returned a value for the ValueList property.
String	name()	For ListEntities, the supported value for this is an EntityId.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	valueList()	ListEntities - This is a list of unique EntityIds.

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

name

public final String name()

For ListEntities, the supported value for this is an EntityId.

For ListChangeSets, the supported values are as follows:

Returns:

For ListEntities, the supported value for this is an EntityId.

For ListChangeSets, the supported values are as follows:

hasValueList

public final boolean hasValueList()

For responses, this returns true if the service returned a value for the ValueList 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.

valueList

public final List<String> valueList()

ListEntities - This is a list of unique EntityIds.

ListChangeSets - The supported filter names and associated ValueLists is as follows:

• ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.

• Status - The supported ValueList is a list of statuses for all change set requests.

• EntityId - The supported ValueList is a list of unique EntityIds.

• BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.

• AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.

• BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.

• AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.

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 hasValueList() method.

Returns:

ListEntities - This is a list of unique EntityIds.

ListChangeSets - The supported filter names and associated ValueLists is as follows:

• ChangeSetName - The supported ValueList is a list of non-unique ChangeSetNames. These are defined when you call the StartChangeSet action.

• Status - The supported ValueList is a list of statuses for all change set requests.

• EntityId - The supported ValueList is a list of unique EntityIds.

• BeforeStartTime - The supported ValueList is a list of all change sets that started before the filter value.

• AfterStartTime - The supported ValueList is a list of all change sets that started after the filter value.

• BeforeEndTime - The supported ValueList is a list of all change sets that ended before the filter value.

• AfterEndTime - The supported ValueList is a list of all change sets that ended after the filter value.

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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