ComponentProperty (AWS Java SDK :: Services :: Amplify UI Builder 2.20.98 API)

java.lang.Object
- software.amazon.awssdk.services.amplifyuibuilder.model.ComponentProperty

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ComponentProperty.Builder,ComponentProperty>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ComponentProperty
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ComponentProperty.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ComponentProperty.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ComponentPropertyBindingProperties`	`bindingProperties()` The information to bind the component property to data at runtime.
`Map<String,FormBindingElement>`	`bindings()` The information to bind the component property to form data.
`static ComponentProperty.Builder`	`builder()`
`ComponentPropertyBindingProperties`	`collectionBindingProperties()` The information to bind the component property to data at runtime.
`String`	`componentName()` The name of the component that is affected by an event.
`List<ComponentProperty>`	`concat()` A list of component properties to concatenate to create the value to assign to this component property.
`ComponentConditionProperty`	`condition()` The conditional expression to use to assign a value to the component property.
`Boolean`	`configured()` Specifies whether the user configured the property in Amplify Studio after importing it.
`String`	`defaultValue()` The default value to assign to the component property.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`event()` An event that occurs in your app.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBindings()` For responses, this returns true if the service returned a value for the Bindings property.
`boolean`	`hasConcat()` For responses, this returns true if the service returned a value for the Concat property.
`int`	`hashCode()`
`String`	`importedValue()` The default value assigned to the property when the component is imported into an app.
`String`	`model()` The data model to use to assign a value to the component property.
`String`	`property()` The name of the component's property that is affected by an event.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ComponentProperty.Builder>`	`serializableBuilderClass()`
`ComponentProperty.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`type()` The component type.
`String`	`userAttribute()` An authenticated user attribute to use to assign a value to the component property.
`String`	`value()` The value to assign to the component property.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - value
```
public final String value()
```
    The value to assign to the component property.
    
    Returns:
    
    The value to assign to the component property.
  - bindingProperties
```
public final ComponentPropertyBindingProperties 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
```
public final ComponentPropertyBindingProperties 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
```
public final String defaultValue()
```
    The default value to assign to the component property.
    
    Returns:
    
    The default value to assign to the component property.
  - model
```
public final String 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 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.
  - bindings
```
public final Map<String,FormBindingElement> 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
```
public final String 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
```
public final String 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 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.
  - concat
```
public final List<ComponentProperty> 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
```
public final ComponentConditionProperty 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
```
public final Boolean 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
```
public final String type()
```
    The component type.
    
    Returns:
    
    The component type.
  - importedValue
```
public final String 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
```
public final String 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
```
public final String 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
```
public ComponentProperty.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ComponentProperty.Builder,ComponentProperty>
  - builder
```
public static ComponentProperty.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ComponentProperty.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ComponentProperty

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

value

bindingProperties

collectionBindingProperties

defaultValue

model

hasBindings

bindings

event

userAttribute

hasConcat

concat

condition

configured

type

importedValue

componentName

property

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields