software.amazon.awssdk.services.amplifyuibuilder.model

Interface ComponentProperty.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ComponentProperty.Builder,ComponentProperty>, SdkBuilder<ComponentProperty.Builder,ComponentProperty>, SdkPojo

Enclosing class:

ComponentProperty

public static interface ComponentProperty.Builder
extends SdkPojo, CopyableBuilder<ComponentProperty.Builder,ComponentProperty>

Method Summary

Modifier and Type	Method and Description
ComponentProperty.Builder	bindingProperties(ComponentPropertyBindingProperties bindingProperties) The information to bind the component property to data at runtime.
default ComponentProperty.Builder	bindingProperties(Consumer<ComponentPropertyBindingProperties.Builder> bindingProperties) The information to bind the component property to data at runtime.
ComponentProperty.Builder	bindings(Map<String,FormBindingElement> bindings) The information to bind the component property to form data.
ComponentProperty.Builder	collectionBindingProperties(ComponentPropertyBindingProperties collectionBindingProperties) The information to bind the component property to data at runtime.
default ComponentProperty.Builder	collectionBindingProperties(Consumer<ComponentPropertyBindingProperties.Builder> collectionBindingProperties) The information to bind the component property to data at runtime.
ComponentProperty.Builder	componentName(String componentName) The name of the component that is affected by an event.
ComponentProperty.Builder	concat(Collection<ComponentProperty> concat) A list of component properties to concatenate to create the value to assign to this component property.
ComponentProperty.Builder	concat(ComponentProperty... concat) A list of component properties to concatenate to create the value to assign to this component property.
ComponentProperty.Builder	concat(Consumer<ComponentProperty.Builder>... concat) A list of component properties to concatenate to create the value to assign to this component property.
ComponentProperty.Builder	condition(ComponentConditionProperty condition) The conditional expression to use to assign a value to the component property.
default ComponentProperty.Builder	condition(Consumer<ComponentConditionProperty.Builder> condition) The conditional expression to use to assign a value to the component property.
ComponentProperty.Builder	configured(Boolean configured) Specifies whether the user configured the property in Amplify Studio after importing it.
ComponentProperty.Builder	defaultValue(String defaultValue) The default value to assign to the component property.
ComponentProperty.Builder	event(String event) An event that occurs in your app.
ComponentProperty.Builder	importedValue(String importedValue) The default value assigned to the property when the component is imported into an app.
ComponentProperty.Builder	model(String model) The data model to use to assign a value to the component property.
ComponentProperty.Builder	property(String property) The name of the component's property that is affected by an event.
ComponentProperty.Builder	type(String type) The component type.
ComponentProperty.Builder	userAttribute(String userAttribute) An authenticated user attribute to use to assign a value to the component property.
ComponentProperty.Builder	value(String value) The value to assign to the component property.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

value

ComponentProperty.Builder value(String value)

The value to assign to the component property.

Parameters:

value - The value to assign to the component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

bindingProperties

ComponentProperty.Builder bindingProperties(ComponentPropertyBindingProperties bindingProperties)

The information to bind the component property to data at runtime.

Parameters:

bindingProperties - The information to bind the component property to data at runtime.

Returns:

Returns a reference to this object so that method calls can be chained together.

bindingProperties

default ComponentProperty.Builder bindingProperties(Consumer<ComponentPropertyBindingProperties.Builder> bindingProperties)

The information to bind the component property to data at runtime.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bindingProperties(ComponentPropertyBindingProperties).

Parameters:

bindingProperties - a consumer that will call methods on ComponentPropertyBindingProperties.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

bindingProperties(ComponentPropertyBindingProperties)

collectionBindingProperties

ComponentProperty.Builder collectionBindingProperties(ComponentPropertyBindingProperties collectionBindingProperties)

The information to bind the component property to data at runtime. Use this for collection components.

Parameters:

collectionBindingProperties - The information to bind the component property to data at runtime. Use this for collection components.

Returns:

Returns a reference to this object so that method calls can be chained together.

collectionBindingProperties

default ComponentProperty.Builder collectionBindingProperties(Consumer<ComponentPropertyBindingProperties.Builder> collectionBindingProperties)

The information to bind the component property to data at runtime. Use this for collection components.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to collectionBindingProperties(ComponentPropertyBindingProperties).

Parameters:

collectionBindingProperties - a consumer that will call methods on ComponentPropertyBindingProperties.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

collectionBindingProperties(ComponentPropertyBindingProperties)

defaultValue

ComponentProperty.Builder defaultValue(String defaultValue)

The default value to assign to the component property.

Parameters:

defaultValue - The default value to assign to the component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

model

ComponentProperty.Builder model(String model)

The data model to use to assign a value to the component property.

Parameters:

model - The data model to use to assign a value to the component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

bindings

ComponentProperty.Builder bindings(Map<String,FormBindingElement> bindings)

The information to bind the component property to form data.

Parameters:

bindings - The information to bind the component property to form data.

Returns:

Returns a reference to this object so that method calls can be chained together.

event

ComponentProperty.Builder event(String event)

An event that occurs in your app. Use this for workflow data binding.

Parameters:

event - An event that occurs in your app. Use this for workflow data binding.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttribute

ComponentProperty.Builder userAttribute(String userAttribute)

An authenticated user attribute to use to assign a value to the component property.

Parameters:

userAttribute - An authenticated user attribute to use to assign a value to the component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

concat

ComponentProperty.Builder concat(Collection<ComponentProperty> concat)

A list of component properties to concatenate to create the value to assign to this component property.

Parameters:

concat - A list of component properties to concatenate to create the value to assign to this component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

concat

ComponentProperty.Builder concat(ComponentProperty... concat)

A list of component properties to concatenate to create the value to assign to this component property.

Parameters:

concat - A list of component properties to concatenate to create the value to assign to this component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

concat

ComponentProperty.Builder concat(Consumer<ComponentProperty.Builder>... concat)

A list of component properties to concatenate to create the value to assign to this component property.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #concat(List).

Parameters:

concat - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#concat(java.util.Collection)

condition

ComponentProperty.Builder condition(ComponentConditionProperty condition)

The conditional expression to use to assign a value to the component property.

Parameters:

condition - The conditional expression to use to assign a value to the component property.

Returns:

Returns a reference to this object so that method calls can be chained together.

condition

default ComponentProperty.Builder condition(Consumer<ComponentConditionProperty.Builder> condition)

The conditional expression to use to assign a value to the component property.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to condition(ComponentConditionProperty).

Parameters:

condition - a consumer that will call methods on ComponentConditionProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

condition(ComponentConditionProperty)

configured

ComponentProperty.Builder configured(Boolean configured)

Specifies whether the user configured the property in Amplify Studio after importing it.

Parameters:

configured - Specifies whether the user configured the property in Amplify Studio after importing it.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

ComponentProperty.Builder type(String type)

The component type.

Parameters:

type - The component type.

Returns:

Returns a reference to this object so that method calls can be chained together.

importedValue

ComponentProperty.Builder importedValue(String importedValue)

The default value assigned to the property when the component is imported into an app.

Parameters:

importedValue - The default value assigned to the property when the component is imported into an app.

Returns:

Returns a reference to this object so that method calls can be chained together.

componentName

ComponentProperty.Builder componentName(String componentName)

The name of the component that is affected by an event.

Parameters:

componentName - The name of the component that is affected by an event.

Returns:

Returns a reference to this object so that method calls can be chained together.

property

ComponentProperty.Builder property(String property)

The name of the component's property that is affected by an event.

Parameters:

property - The name of the component's property that is affected by an event.

Returns:

Returns a reference to this object so that method calls can be chained together.