Interface ComponentProperty.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ComponentProperty.Builder,
,ComponentProperty> SdkBuilder<ComponentProperty.Builder,
,ComponentProperty> SdkPojo
- Enclosing class:
ComponentProperty
-
Method Summary
Modifier and TypeMethodDescriptiondefault ComponentProperty.Builder
bindingProperties
(Consumer<ComponentPropertyBindingProperties.Builder> bindingProperties) The information to bind the component property to data at runtime.bindingProperties
(ComponentPropertyBindingProperties bindingProperties) The information to bind the component property to data at runtime.bindings
(Map<String, FormBindingElement> bindings) The information to bind the component property to form data.default ComponentProperty.Builder
collectionBindingProperties
(Consumer<ComponentPropertyBindingProperties.Builder> collectionBindingProperties) The information to bind the component property to data at runtime.collectionBindingProperties
(ComponentPropertyBindingProperties collectionBindingProperties) The information to bind the component property to data at runtime.componentName
(String componentName) The name of the component that is affected by an event.concat
(Collection<ComponentProperty> concat) A list of component properties to concatenate to create the value to assign to this component property.concat
(Consumer<ComponentProperty.Builder>... concat) A list of component properties to concatenate to create the value to assign to this component property.concat
(ComponentProperty... concat) A list of component properties to concatenate to create the value to assign to this component property.default ComponentProperty.Builder
condition
(Consumer<ComponentConditionProperty.Builder> condition) The conditional expression to use to assign a value to the component property.condition
(ComponentConditionProperty condition) The conditional expression to use to assign a value to the component property.configured
(Boolean configured) Specifies whether the user configured the property in Amplify Studio after importing it.defaultValue
(String defaultValue) The default value to assign to the component property.An event that occurs in your app.importedValue
(String importedValue) The default value assigned to the property when the component is imported into an app.The data model to use to assign a value to the component property.The name of the component's property that is affected by an event.The component type.userAttribute
(String userAttribute) An authenticated user attribute to use to assign a value to the component property.The value to assign to the component property.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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 theComponentPropertyBindingProperties.Builder
avoiding the need to create one manually viaComponentPropertyBindingProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobindingProperties(ComponentPropertyBindingProperties)
.- Parameters:
bindingProperties
- a consumer that will call methods onComponentPropertyBindingProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theComponentPropertyBindingProperties.Builder
avoiding the need to create one manually viaComponentPropertyBindingProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocollectionBindingProperties(ComponentPropertyBindingProperties)
.- Parameters:
collectionBindingProperties
- a consumer that will call methods onComponentPropertyBindingProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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
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
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
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 theComponentProperty.Builder
avoiding the need to create one manually viaComponentProperty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconcat(List<ComponentProperty>)
.- Parameters:
concat
- a consumer that will call methods onComponentProperty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The conditional expression to use to assign a value to the component property.
This is a convenience method that creates an instance of theComponentConditionProperty.Builder
avoiding the need to create one manually viaComponentConditionProperty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocondition(ComponentConditionProperty)
.- Parameters:
condition
- a consumer that will call methods onComponentConditionProperty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The component type.
- Parameters:
type
- The component type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
-