@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ActionParameters extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
ActionParameters() |
Modifier and Type | Method and Description |
---|---|
ActionParameters |
addFieldsEntry(String key,
ComponentProperty value)
Add a single Fields entry
|
ActionParameters |
clearFieldsEntries()
Removes all the entries added into Fields.
|
ActionParameters |
clone() |
boolean |
equals(Object obj) |
ComponentProperty |
getAnchor()
The HTML anchor link to the location to open.
|
Map<String,ComponentProperty> |
getFields()
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
|
ComponentProperty |
getGlobal()
Specifies whether the user should be signed out globally.
|
ComponentProperty |
getId()
The unique ID of the component that the
ActionParameters apply to. |
String |
getModel()
The name of the data model.
|
MutationActionSetStateParameter |
getState()
A key-value pair that specifies the state property name and its initial value.
|
ComponentProperty |
getTarget()
The element within the same component to modify when the action occurs.
|
ComponentProperty |
getType()
The type of navigation action.
|
ComponentProperty |
getUrl()
The URL to the location to open.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAnchor(ComponentProperty anchor)
The HTML anchor link to the location to open.
|
void |
setFields(Map<String,ComponentProperty> fields)
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
|
void |
setGlobal(ComponentProperty global)
Specifies whether the user should be signed out globally.
|
void |
setId(ComponentProperty id)
The unique ID of the component that the
ActionParameters apply to. |
void |
setModel(String model)
The name of the data model.
|
void |
setState(MutationActionSetStateParameter state)
A key-value pair that specifies the state property name and its initial value.
|
void |
setTarget(ComponentProperty target)
The element within the same component to modify when the action occurs.
|
void |
setType(ComponentProperty type)
The type of navigation action.
|
void |
setUrl(ComponentProperty url)
The URL to the location to open.
|
String |
toString()
Returns a string representation of this object.
|
ActionParameters |
withAnchor(ComponentProperty anchor)
The HTML anchor link to the location to open.
|
ActionParameters |
withFields(Map<String,ComponentProperty> fields)
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
|
ActionParameters |
withGlobal(ComponentProperty global)
Specifies whether the user should be signed out globally.
|
ActionParameters |
withId(ComponentProperty id)
The unique ID of the component that the
ActionParameters apply to. |
ActionParameters |
withModel(String model)
The name of the data model.
|
ActionParameters |
withState(MutationActionSetStateParameter state)
A key-value pair that specifies the state property name and its initial value.
|
ActionParameters |
withTarget(ComponentProperty target)
The element within the same component to modify when the action occurs.
|
ActionParameters |
withType(ComponentProperty type)
The type of navigation action.
|
ActionParameters |
withUrl(ComponentProperty url)
The URL to the location to open.
|
public void setType(ComponentProperty type)
The type of navigation action. Valid values are url
and anchor
. This value is required
for a navigation action.
type
- The type of navigation action. Valid values are url
and anchor
. This value is
required for a navigation action.public ComponentProperty getType()
The type of navigation action. Valid values are url
and anchor
. This value is required
for a navigation action.
url
and anchor
. This value is
required for a navigation action.public ActionParameters withType(ComponentProperty type)
The type of navigation action. Valid values are url
and anchor
. This value is required
for a navigation action.
type
- The type of navigation action. Valid values are url
and anchor
. This value is
required for a navigation action.public void setUrl(ComponentProperty url)
The URL to the location to open. Specify this value for a navigation action.
url
- The URL to the location to open. Specify this value for a navigation action.public ComponentProperty getUrl()
The URL to the location to open. Specify this value for a navigation action.
public ActionParameters withUrl(ComponentProperty url)
The URL to the location to open. Specify this value for a navigation action.
url
- The URL to the location to open. Specify this value for a navigation action.public void setAnchor(ComponentProperty anchor)
The HTML anchor link 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.public ComponentProperty getAnchor()
The HTML anchor link to the location to open. Specify this value for a navigation action.
public ActionParameters withAnchor(ComponentProperty anchor)
The HTML anchor link 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.public void setTarget(ComponentProperty target)
The element within the same component to modify when the action occurs.
target
- The element within the same component to modify when the action occurs.public ComponentProperty getTarget()
The element within the same component to modify when the action occurs.
public ActionParameters withTarget(ComponentProperty target)
The element within the same component to modify when the action occurs.
target
- The element within the same component to modify when the action occurs.public void setGlobal(ComponentProperty global)
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
global
- Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.public ComponentProperty getGlobal()
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
public ActionParameters withGlobal(ComponentProperty global)
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
global
- Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.public void setModel(String model)
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
model
- The name of the data model. Use when the action performs an operation on an Amplify DataStore model.public String getModel()
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
public ActionParameters withModel(String model)
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
model
- The name of the data model. Use when the action performs an operation on an Amplify DataStore model.public void setId(ComponentProperty id)
The unique ID of the component that the ActionParameters
apply to.
id
- The unique ID of the component that the ActionParameters
apply to.public ComponentProperty getId()
The unique ID of the component that the ActionParameters
apply to.
ActionParameters
apply to.public ActionParameters withId(ComponentProperty id)
The unique ID of the component that the ActionParameters
apply to.
id
- The unique ID of the component that the ActionParameters
apply to.public Map<String,ComponentProperty> getFields()
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.
public void setFields(Map<String,ComponentProperty> 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.
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.public ActionParameters withFields(Map<String,ComponentProperty> 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.
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.public ActionParameters addFieldsEntry(String key, ComponentProperty value)
public ActionParameters clearFieldsEntries()
public void setState(MutationActionSetStateParameter state)
A key-value pair that specifies the state property name and its initial value.
state
- A key-value pair that specifies the state property name and its initial value.public MutationActionSetStateParameter getState()
A key-value pair that specifies the state property name and its initial value.
public ActionParameters withState(MutationActionSetStateParameter state)
A key-value pair that specifies the state property name and its initial value.
state
- A key-value pair that specifies the state property name and its initial value.public String toString()
toString
in class Object
Object.toString()
public ActionParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.