Class CreateComponentData
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CreateComponentData.Builder,
CreateComponentData>
Represents all of the information that is required to create a component.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe data binding information for the component's properties.static CreateComponentData.Builder
builder()
final List
<ComponentChild> children()
A list of child components that are instances of the main component.final Map
<String, ComponentDataConfiguration> The data binding configuration for customizing a component's properties.final String
The component type.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()
The event configuration for the 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 BindingProperties property.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 CollectionProperties 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 Overrides property.final boolean
For responses, this returns true if the service returned a value for the Properties property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Variants property.final String
name()
The name of the componentDescribes the component properties that can be overriden to customize an instance of the component.final Map
<String, ComponentProperty> Describes the component's properties.final String
The schema version of the component when it was imported.static Class
<? extends CreateComponentData.Builder> final String
sourceId()
The unique ID of the component in its original source system, such as Figma.tags()
One or more key-value pairs to use when tagging the component data.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.final List
<ComponentVariant> variants()
A list of the unique variants of this component.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the component
- Returns:
- The name of the component
-
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
The component type. This can be an Amplify custom UI component or another custom component.
- Returns:
- The component type. 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 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 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 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
A list of child 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:
- A list of child 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 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. -
variants
A list of the unique variants of 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
hasVariants()
method.- Returns:
- A list of the unique variants of this component.
-
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 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. -
overrides
Describes the component properties that can be overriden to customize an instance of 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 component properties that can be overriden to customize an instance of 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 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. -
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 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. -
collectionProperties
The data binding configuration for customizing a component's properties. 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 data binding configuration for customizing a component's properties. Use this for a collection component.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
One or more key-value pairs to use when tagging the component data.
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
hasTags()
method.- Returns:
- One or more key-value pairs to use when tagging the component data.
-
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
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
The schema version of the component when it was imported.
- Returns:
- The schema version of the component when it was imported.
-
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<CreateComponentData.Builder,
CreateComponentData> - 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
-