Interface UpdateComponentData.Builder

All Superinterfaces:
Buildable, CopyableBuilder<UpdateComponentData.Builder,UpdateComponentData>, SdkBuilder<UpdateComponentData.Builder,UpdateComponentData>, SdkPojo
Enclosing class:
UpdateComponentData
@Mutable @NotThreadSafe public static interface UpdateComponentData.Builder extends SdkPojo, CopyableBuilder<UpdateComponentData.Builder,UpdateComponentData>

  • Method Details

    • id

      UpdateComponentData.Builder id(String id)

      The unique ID of the component to update.

      Parameters:
      id - The unique ID of the component to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateComponentData.Builder name(String name)

      The name of the component to update.

      Parameters:
      name - The name of the component to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceId

      UpdateComponentData.Builder sourceId(String sourceId)

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

      Parameters:
      sourceId - The unique ID of the component in its original source system, such as Figma.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • componentType

      UpdateComponentData.Builder componentType(String componentType)

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

      Parameters:
      componentType - The type of the component. This can be an Amplify custom UI component or another custom component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • properties

      UpdateComponentData.Builder properties(Map<String,ComponentProperty> properties)

      Describes the component's properties.

      Parameters:
      properties - Describes the component's properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • children

      UpdateComponentData.Builder children(Collection<ComponentChild> children)

      The components that are instances of the main component.

      Parameters:
      children - The components that are instances of the main component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • children

      UpdateComponentData.Builder children(ComponentChild... children)

      The components that are instances of the main component.

      Parameters:
      children - The components that are instances of the main component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • children

      UpdateComponentData.Builder children(Consumer<ComponentChild.Builder>... children)

      The components that are instances of the main component.

      This is a convenience method that creates an instance of the ComponentChild.Builder avoiding the need to create one manually via ComponentChild.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to children(List<ComponentChild>).

      Parameters:
      children - a consumer that will call methods on ComponentChild.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • variants

      UpdateComponentData.Builder variants(Collection<ComponentVariant> variants)

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

      Parameters:
      variants - A list of the unique variants of the main component being updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variants

      UpdateComponentData.Builder variants(ComponentVariant... variants)

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

      Parameters:
      variants - A list of the unique variants of the main component being updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variants

      UpdateComponentData.Builder variants(Consumer<ComponentVariant.Builder>... variants)

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

      This is a convenience method that creates an instance of the ComponentVariant.Builder avoiding the need to create one manually via ComponentVariant.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to variants(List<ComponentVariant>).

      Parameters:
      variants - a consumer that will call methods on ComponentVariant.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrides

      UpdateComponentData.Builder overrides(Map<String,? extends Map<String,String>> overrides)

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

      Parameters:
      overrides - Describes the properties that can be overriden to customize the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bindingProperties

      UpdateComponentData.Builder bindingProperties(Map<String,ComponentBindingPropertiesValue> bindingProperties)

      The data binding information for the component's properties.

      Parameters:
      bindingProperties - The data binding information for the component's properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • collectionProperties

      UpdateComponentData.Builder collectionProperties(Map<String,ComponentDataConfiguration> collectionProperties)

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

      Parameters:
      collectionProperties - The configuration for binding a component's properties to a data model. Use this for a collection component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      UpdateComponentData.Builder events(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schemaVersion

      UpdateComponentData.Builder schemaVersion(String schemaVersion)

      The schema version of the component when it was imported.

      Parameters:
      schemaVersion - The schema version of the component when it was imported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.