Class Component

java.lang.Object
software.amazon.awssdk.services.amplifyuibuilder.model.Component
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Component.Builder,Component>
@Generated("software.amazon.awssdk:codegen") public final class Component extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Component.Builder,Component>

Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use ComponentChild to configure an instance of a Component. A ComponentChild instance inherits the configuration of the main Component.

See Also:

  • Method Details

    • appId

      public final String appId()

      The unique ID of the Amplify app associated with the component.

      Returns:
      The unique ID of the Amplify app associated with the component.

    • environmentName

      public final String environmentName()

      The name of the backend environment that is a part of the Amplify app.

      Returns:
      The name of the backend environment that is a part of the Amplify app.

    • 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.

    • id

      public final String id()

      The unique ID of the component.

      Returns:
      The unique ID of the component.

    • name

      public final String name()

      The name of the component.

      Returns:
      The name of the component.

    • 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. 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 component's properties. You can't specify tags as a valid property for 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()

      A list of the component's ComponentChild instances.

      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 the component's ComponentChild instances.

    • 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 component's variants. A variant is a unique style configuration of a 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 hasVariants() method.

      Returns:
      A list of the component's variants. A variant is a unique style configuration of a main 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 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 component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

      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's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.

    • 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 information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

      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 information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.

    • 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 data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

      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 the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.

    • createdAt

      public final Instant createdAt()

      The time that the component was created.

      Returns:
      The time that the component was created.

    • modifiedAt

      public final Instant modifiedAt()

      The time that the component was modified.

      Returns:
      The time that the component was modified.

    • 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 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.

    • tags

      public final Map<String,String> tags()

      One or more key-value pairs to use when tagging 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 hasTags() method.

      Returns:
      One or more key-value pairs to use when tagging the 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 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 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 Component.Builder 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 interface ToCopyableBuilder<Component.Builder,Component>
      Returns:
      a builder for type T

    • builder

      public static Component.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Component.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.