Class ActionParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ActionParameters.Builder,
ActionParameters>
Represents the event action configuration for an element of a Component
or ComponentChild
.
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
ActionParameters
defines the action that is performed when an event occurs on the component.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ComponentProperty
anchor()
The HTML anchor link to the location to open.static ActionParameters.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, ComponentProperty> fields()
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final ComponentProperty
global()
Specifies whether the user should be signed out globally.final boolean
For responses, this returns true if the service returned a value for the Fields property.final int
hashCode()
final ComponentProperty
id()
The unique ID of the component that theActionParameters
apply to.final String
model()
The name of the data model.static Class
<? extends ActionParameters.Builder> state()
A key-value pair that specifies the state property name and its initial value.final ComponentProperty
target()
The element within the same component to modify when the action occurs.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 ComponentProperty
type()
The type of navigation action.final ComponentProperty
url()
The URL to the location to open.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
type
The type of navigation action. Valid values are
url
andanchor
. This value is required for a navigation action.- Returns:
- The type of navigation action. Valid values are
url
andanchor
. This value is required for a navigation action.
-
url
The URL to the location to open. Specify this value for a navigation action.
- Returns:
- The URL to the location to open. Specify this value for a navigation action.
-
anchor
The HTML anchor link to the location to open. Specify this value for a navigation action.
- Returns:
- The HTML anchor link to the location to open. Specify this value for a navigation action.
-
target
The element within the same component to modify when the action occurs.
- Returns:
- The element within the same component to modify when the action occurs.
-
global
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
- Returns:
- Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
-
model
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
- Returns:
- The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
-
id
The unique ID of the component that the
ActionParameters
apply to.- Returns:
- The unique ID of the component that the
ActionParameters
apply to.
-
hasFields
public final boolean hasFields()For responses, this returns true if the service returned a value for the Fields 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. -
fields
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
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
hasFields()
method.- Returns:
- A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
-
state
A key-value pair that specifies the state property name and its initial value.
- Returns:
- A key-value pair that specifies the state property name and its initial value.
-
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<ActionParameters.Builder,
ActionParameters> - 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
-