ActionParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplifyuibuilder.model.ActionParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActionParameters()

Constructors
Constructor and Description
`ActionParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - ActionParameters
```
public ActionParameters()
```
- Method Detail
  - setType
```
public void setType(ComponentProperty type)
```
    The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    
    Parameters:
    
    type - The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
  - getType
```
public ComponentProperty getType()
```
    The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    
    Returns:
    
    The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
  - withType
```
public ActionParameters withType(ComponentProperty type)
```
    The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    
    Parameters:
    
    type - The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUrl
```
public void setUrl(ComponentProperty url)
```
    The URL to the location to open. Specify this value for a navigation action.
    
    Parameters:
    
    url - The URL to the location to open. Specify this value for a navigation action.
  - getUrl
```
public ComponentProperty getUrl()
```
    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.
  - withUrl
```
public ActionParameters withUrl(ComponentProperty url)
```
    The URL to the location to open. Specify this value for a navigation action.
    
    Parameters:
    
    url - The URL to the location to open. Specify this value for a navigation action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAnchor
```
public void setAnchor(ComponentProperty anchor)
```
    The HTML anchor link to the location to open. Specify this value for a navigation action.
    
    Parameters:
    
    anchor - The HTML anchor link to the location to open. Specify this value for a navigation action.
  - getAnchor
```
public ComponentProperty getAnchor()
```
    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.
  - withAnchor
```
public ActionParameters withAnchor(ComponentProperty anchor)
```
    The HTML anchor link to the location to open. Specify this value for a navigation action.
    
    Parameters:
    
    anchor - The HTML anchor link to the location to open. Specify this value for a navigation action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTarget
```
public void setTarget(ComponentProperty target)
```
    The element within the same component to modify when the action occurs.
    
    Parameters:
    
    target - The element within the same component to modify when the action occurs.
  - getTarget
```
public ComponentProperty getTarget()
```
    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.
  - withTarget
```
public ActionParameters withTarget(ComponentProperty target)
```
    The element within the same component to modify when the action occurs.
    
    Parameters:
    
    target - The element within the same component to modify when the action occurs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGlobal
```
public void setGlobal(ComponentProperty global)
```
    Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
    
    Parameters:
    
    global - Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
  - getGlobal
```
public ComponentProperty getGlobal()
```
    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.
  - withGlobal
```
public ActionParameters withGlobal(ComponentProperty global)
```
    Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
    
    Parameters:
    
    global - Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModel
```
public void setModel(String model)
```
    The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
    
    Parameters:
    
    model - The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
  - getModel
```
public String getModel()
```
    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.
  - withModel
```
public ActionParameters withModel(String model)
```
    The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
    
    Parameters:
    
    model - The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(ComponentProperty id)
```
    The unique ID of the component that the ActionParameters apply to.
    
    Parameters:
    
    id - The unique ID of the component that the ActionParameters apply to.
  - getId
```
public ComponentProperty getId()
```
    The unique ID of the component that the ActionParameters apply to.
    
    Returns:
    
    The unique ID of the component that the ActionParameters apply to.
  - withId
```
public ActionParameters withId(ComponentProperty id)
```
    The unique ID of the component that the ActionParameters apply to.
    
    Parameters:
    
    id - The unique ID of the component that the ActionParameters apply to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFields
```
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.
    
    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.
  - setFields
```
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.
    
    Parameters:
    
    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.
  - withFields
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addFieldsEntry
```
public ActionParameters addFieldsEntry(String key,
                                       ComponentProperty value)
```
    Add a single Fields entry
    
    See Also:
    
    withFields(java.util.Map<java.lang.String, com.amazonaws.services.amplifyuibuilder.model.ComponentProperty>)
  - clearFieldsEntries
```
public ActionParameters clearFieldsEntries()
```
    Removes all the entries added into Fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(MutationActionSetStateParameter state)
```
    A key-value pair that specifies the state property name and its initial value.
    
    Parameters:
    
    state - A key-value pair that specifies the state property name and its initial value.
  - getState
```
public MutationActionSetStateParameter getState()
```
    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.
  - withState
```
public ActionParameters withState(MutationActionSetStateParameter state)
```
    A key-value pair that specifies the state property name and its initial value.
    
    Parameters:
    
    state - A key-value pair that specifies the state property name and its initial value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ActionParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class ActionParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActionParameters

Method Detail

setType

getType

withType

setUrl

getUrl

withUrl

setAnchor

getAnchor

withAnchor

setTarget

getTarget

withTarget

setGlobal

getGlobal

withGlobal

setModel

getModel

withModel

setId

getId

withId

getFields

setFields

withFields

addFieldsEntry

clearFieldsEntries

setState

getState

withState

toString

equals

hashCode

clone

marshall