Package software.amazon.awssdk.services.amplifyuibuilder.model

Class ComponentDataConfiguration

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.ComponentDataConfiguration

All Implemented Interfaces:

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

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

Describes the configuration for binding a component's properties to data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ComponentDataConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ComponentDataConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIdentifiers()	For responses, this returns true if the service returned a value for the Identifiers property.
boolean	hasSort()	For responses, this returns true if the service returned a value for the Sort property.
List<String>	identifiers()	A list of IDs to use to bind data to a component.
String	model()	The name of the data model to use to bind data to a component.
Predicate	predicate()	Represents the conditional logic to use when binding data to a component.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentDataConfiguration.Builder>	serializableBuilderClass()
List<SortProperty>	sort()	Describes how to sort the component's properties.
ComponentDataConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

model

public final String model()

The name of the data model to use to bind data to a component.

Returns:

The name of the data model to use to bind data to a component.

hasSort

public final boolean hasSort()

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

sort

public final List<SortProperty> sort()

Describes how to sort the component's properties.

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

Returns:

Describes how to sort the component's properties.

predicate

public final Predicate predicate()

Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.

Returns:

Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.

hasIdentifiers

public final boolean hasIdentifiers()

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

identifiers

public final List<String> identifiers()

A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.

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

Returns:

A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.

toBuilder

public ComponentDataConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentDataConfiguration.Builder,ComponentDataConfiguration>

builder

public static ComponentDataConfiguration.Builder builder()

serializableBuilderClass

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