software.amazon.awssdk.services.amplifyuibuilder.model

Class ComponentChild

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.ComponentChild

All Implemented Interfaces:

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

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

A nested UI configuration within a parent Component.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComponentChild.Builder

Method Summary

Modifier and Type	Method and Description
static ComponentChild.Builder	builder()
List<ComponentChild>	children() The list of ComponentChild instances for this component.
String	componentType() The type of the child component.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,ComponentEvent>	events() Describes the events that can be raised on the child component.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChildren() For responses, this returns true if the service returned a value for the Children property.
boolean	hasEvents() For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
boolean	hasProperties() For responses, this returns true if the service returned a value for the Properties property.
String	name() The name of the child component.
Map<String,ComponentProperty>	properties() Describes the properties of the child component.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentChild.Builder>	serializableBuilderClass()
String	sourceId() The unique ID of the child component in its original source system, such as Figma.
ComponentChild.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

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 list of ComponentChild instances for this 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 list of ComponentChild instances for this component.

componentType

public final String componentType()

The type of the child component.

Returns:

The type of the child 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()

Describes the events that can be raised on the child 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:

Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

name

public final String name()

The name of the child component.

Returns:

The name of the child 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 properties of the child component. You can't specify tags as a valid property for 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 properties of the child component. You can't specify tags as a valid property for properties.

sourceId

public final String sourceId()

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

Returns:

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

toBuilder

public ComponentChild.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentChild.Builder,ComponentChild>

builder

public static ComponentChild.Builder builder()

serializableBuilderClass

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