Class ComponentProperty
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComponentProperty.Builder,
ComponentProperty>
Describes the configuration for all of a component's properties. Use ComponentProperty
to specify the
values to render or bind by default.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe information to bind the component property to data at runtime.final Map
<String, FormBindingElement> bindings()
The information to bind the component property to form data.static ComponentProperty.Builder
builder()
The information to bind the component property to data at runtime.final String
The name of the component that is affected by an event.final List
<ComponentProperty> concat()
A list of component properties to concatenate to create the value to assign to this component property.The conditional expression to use to assign a value to the component property.final Boolean
Specifies whether the user configured the property in Amplify Studio after importing it.final String
The default value to assign to the component property.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
event()
An event that occurs in your app.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 Bindings property.final boolean
For responses, this returns true if the service returned a value for the Concat property.final int
hashCode()
final String
The default value assigned to the property when the component is imported into an app.final String
model()
The data model to use to assign a value to the component property.final String
property()
The name of the component's property that is affected by an event.static Class
<? extends ComponentProperty.Builder> 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 String
type()
The component type.final String
An authenticated user attribute to use to assign a value to the component property.final String
value()
The value to assign to the component property.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
value
The value to assign to the component property.
- Returns:
- The value to assign to the component property.
-
bindingProperties
The information to bind the component property to data at runtime.
- Returns:
- The information to bind the component property to data at runtime.
-
collectionBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
- Returns:
- The information to bind the component property to data at runtime. Use this for collection components.
-
defaultValue
The default value to assign to the component property.
- Returns:
- The default value to assign to the component property.
-
model
The data model to use to assign a value to the component property.
- Returns:
- The data model to use to assign a value to the component property.
-
hasBindings
public final boolean hasBindings()For responses, this returns true if the service returned a value for the Bindings 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. -
bindings
The information to bind the component property to form 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
hasBindings()
method.- Returns:
- The information to bind the component property to form data.
-
event
An event that occurs in your app. Use this for workflow data binding.
- Returns:
- An event that occurs in your app. Use this for workflow data binding.
-
userAttribute
An authenticated user attribute to use to assign a value to the component property.
- Returns:
- An authenticated user attribute to use to assign a value to the component property.
-
hasConcat
public final boolean hasConcat()For responses, this returns true if the service returned a value for the Concat 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. -
concat
A list of component properties to concatenate to create the value to assign to this component property.
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
hasConcat()
method.- Returns:
- A list of component properties to concatenate to create the value to assign to this component property.
-
condition
The conditional expression to use to assign a value to the component property.
- Returns:
- The conditional expression to use to assign a value to the component property.
-
configured
Specifies whether the user configured the property in Amplify Studio after importing it.
- Returns:
- Specifies whether the user configured the property in Amplify Studio after importing it.
-
type
The component type.
- Returns:
- The component type.
-
importedValue
The default value assigned to the property when the component is imported into an app.
- Returns:
- The default value assigned to the property when the component is imported into an app.
-
componentName
The name of the component that is affected by an event.
- Returns:
- The name of the component that is affected by an event.
-
property
The name of the component's property that is affected by an event.
- Returns:
- The name of the component's property that is affected by an event.
-
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<ComponentProperty.Builder,
ComponentProperty> - 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
-