software.amazon.awssdk.services.amplifyuibuilder.model

Class UpdateComponentData

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.UpdateComponentData

All Implemented Interfaces:

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

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

Updates and saves all of the information about a component, based on component ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateComponentData.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,ComponentBindingPropertiesValue>	bindingProperties() The data binding information for the component's properties.
static UpdateComponentData.Builder	builder()
List<ComponentChild>	children() The components that are instances of the main component.
Map<String,ComponentDataConfiguration>	collectionProperties() The configuration for binding a component's properties to a data model.
String	componentType() The type of the component.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,ComponentEvent>	events() The event configuration for the component.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBindingProperties() For responses, this returns true if the service returned a value for the BindingProperties property.
boolean	hasChildren() For responses, this returns true if the service returned a value for the Children property.
boolean	hasCollectionProperties() For responses, this returns true if the service returned a value for the CollectionProperties property.
boolean	hasEvents() For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
boolean	hasOverrides() For responses, this returns true if the service returned a value for the Overrides property.
boolean	hasProperties() For responses, this returns true if the service returned a value for the Properties property.
boolean	hasVariants() For responses, this returns true if the service returned a value for the Variants property.
String	id() The unique ID of the component to update.
String	name() The name of the component to update.
Map<String,Map<String,String>>	overrides() Describes the properties that can be overriden to customize the component.
Map<String,ComponentProperty>	properties() Describes the component's properties.
String	schemaVersion() The schema version of the component when it was imported.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateComponentData.Builder>	serializableBuilderClass()
String	sourceId() The unique ID of the component in its original source system, such as Figma.
UpdateComponentData.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ComponentVariant>	variants() A list of the unique variants of the main component being updated.

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

id

public final String id()

The unique ID of the component to update.

Returns:

The unique ID of the component to update.

name

public final String name()

The name of the component to update.

Returns:

The name of the component to update.

sourceId

public final String sourceId()

The unique ID of the component in its original source system, such as Figma.

Returns:

The unique ID of the component in its original source system, such as Figma.

componentType

public final String componentType()

The type of the component. This can be an Amplify custom UI component or another custom component.

Returns:

The type of the component. This can be an Amplify custom UI component or another custom component.

hasProperties

public final boolean hasProperties()

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

properties

public final Map<String,ComponentProperty> properties()

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

Returns:

Describes the component's properties.

hasChildren

public final boolean hasChildren()

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

children

public final List<ComponentChild> children()

The components that are instances of the main component.

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

Returns:

The components that are instances of the main component.

hasVariants

public final boolean hasVariants()

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

variants

public final List<ComponentVariant> variants()

A list of the unique variants of the main component being updated.

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

Returns:

A list of the unique variants of the main component being updated.

hasOverrides

public final boolean hasOverrides()

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

overrides

public final Map<String,Map<String,String>> overrides()

Describes the properties that can be overriden to customize the component.

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

Returns:

Describes the properties that can be overriden to customize the component.

hasBindingProperties

public final boolean hasBindingProperties()

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

bindingProperties

public final Map<String,ComponentBindingPropertiesValue> bindingProperties()

The data binding information for 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 hasBindingProperties() method.

Returns:

The data binding information for the component's properties.

hasCollectionProperties

public final boolean hasCollectionProperties()

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

collectionProperties

public final Map<String,ComponentDataConfiguration> collectionProperties()

The configuration for binding a component's properties to a data model. Use this for a collection component.

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

Returns:

The configuration for binding a component's properties to a data model. Use this for a collection component.

hasEvents

public final boolean hasEvents()

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

events

public final Map<String,ComponentEvent> events()

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

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

Returns:

The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

schemaVersion

public final String schemaVersion()

The schema version of the component when it was imported.

Returns:

The schema version of the component when it was imported.

toBuilder

public UpdateComponentData.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateComponentData.Builder,UpdateComponentData>

builder

public static UpdateComponentData.Builder builder()

serializableBuilderClass

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