software.amazon.awssdk.services.customerprofiles.model

Class ObjectFilter

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.ObjectFilter

All Implemented Interfaces:

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

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

The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectFilter.Builder

Method Summary

Modifier and Type	Method and Description
static ObjectFilter.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	keyName() A searchable identifier of a standard profile object.
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectFilter.Builder>	serializableBuilderClass()
ObjectFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() A list of key 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

keyName

public final String keyName()

A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.

Returns:

A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.

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

A list of key values.

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:

A list of key values.

toBuilder

public ObjectFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ObjectFilter.Builder,ObjectFilter>

builder

public static ObjectFilter.Builder builder()

serializableBuilderClass

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