Class ComponentChild
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComponentChild.Builder,
ComponentChild>
A nested UI configuration within a parent Component
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ComponentChild.Builder
builder()
final List
<ComponentChild> children()
The list ofComponentChild
instances for this component.final String
The type of the child component.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, ComponentEvent> events()
Describes the events that can be raised on the child component.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Children property.final boolean
For responses, this returns true if the service returned a value for the Events property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Properties property.final String
name()
The name of the child component.final Map
<String, ComponentProperty> Describes the properties of the child component.static Class
<? extends ComponentChild.Builder> final String
sourceId()
The unique ID of the child component in its original source system, such as Figma.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
componentType
The type of the child component.
- Returns:
- The type of the child component.
-
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 theisEmpty()
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
Describes the properties of the child component. You can't specify
tags
as a valid property forproperties
.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 forproperties
.
-
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 theisEmpty()
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
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.
-
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 theisEmpty()
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
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.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ComponentChild.Builder,
ComponentChild> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-