Interface ActionParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ActionParameters.Builder,ActionParameters>, SdkBuilder<ActionParameters.Builder,ActionParameters>, SdkPojo

Enclosing class:

ActionParameters

@Mutable
@NotThreadSafe
public static interface ActionParameters.Builder
extends SdkPojo, CopyableBuilder<ActionParameters.Builder,ActionParameters>

Method Summary

Modifier and Type	Method	Description
default ActionParameters.Builder	anchor(Consumer<ComponentProperty.Builder> anchor)	The HTML anchor link to the location to open.
ActionParameters.Builder	anchor(ComponentProperty anchor)	The HTML anchor link to the location to open.
ActionParameters.Builder	fields(Map<String,ComponentProperty> fields)	A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
default ActionParameters.Builder	global(Consumer<ComponentProperty.Builder> global)	Specifies whether the user should be signed out globally.
ActionParameters.Builder	global(ComponentProperty global)	Specifies whether the user should be signed out globally.
default ActionParameters.Builder	id(Consumer<ComponentProperty.Builder> id)	The unique ID of the component that the ActionParameters apply to.
ActionParameters.Builder	id(ComponentProperty id)	The unique ID of the component that the ActionParameters apply to.
ActionParameters.Builder	model(String model)	The name of the data model.
default ActionParameters.Builder	state(Consumer<MutationActionSetStateParameter.Builder> state)	A key-value pair that specifies the state property name and its initial value.
ActionParameters.Builder	state(MutationActionSetStateParameter state)	A key-value pair that specifies the state property name and its initial value.
default ActionParameters.Builder	target(Consumer<ComponentProperty.Builder> target)	The element within the same component to modify when the action occurs.
ActionParameters.Builder	target(ComponentProperty target)	The element within the same component to modify when the action occurs.
default ActionParameters.Builder	type(Consumer<ComponentProperty.Builder> type)	The type of navigation action.
ActionParameters.Builder	type(ComponentProperty type)	The type of navigation action.
default ActionParameters.Builder	url(Consumer<ComponentProperty.Builder> url)	The URL to the location to open.
ActionParameters.Builder	url(ComponentProperty url)	The URL to the location to open.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

type

ActionParameters.Builder type(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.

type

default ActionParameters.Builder type(Consumer<ComponentProperty.Builder> type)

The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to type(ComponentProperty).

Parameters:

type - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• type(ComponentProperty)

url

ActionParameters.Builder url(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.

url

default ActionParameters.Builder url(Consumer<ComponentProperty.Builder> url)

The URL to the location to open. Specify this value for a navigation action.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to url(ComponentProperty).

Parameters:

url - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• url(ComponentProperty)

anchor

ActionParameters.Builder anchor(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.

anchor

default ActionParameters.Builder anchor(Consumer<ComponentProperty.Builder> anchor)

The HTML anchor link to the location to open. Specify this value for a navigation action.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to anchor(ComponentProperty).

Parameters:

anchor - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• anchor(ComponentProperty)

target

ActionParameters.Builder target(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.

target

default ActionParameters.Builder target(Consumer<ComponentProperty.Builder> target)

The element within the same component to modify when the action occurs.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to target(ComponentProperty).

Parameters:

target - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• target(ComponentProperty)

global

ActionParameters.Builder global(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.

global

default ActionParameters.Builder global(Consumer<ComponentProperty.Builder> global)

Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to global(ComponentProperty).

Parameters:

global - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• global(ComponentProperty)

model

ActionParameters.Builder model(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.

id

ActionParameters.Builder id(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.

id

default ActionParameters.Builder id(Consumer<ComponentProperty.Builder> id)

The unique ID of the component that the ActionParameters apply to.

This is a convenience method that creates an instance of the ComponentProperty.Builder avoiding the need to create one manually via ComponentProperty.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to id(ComponentProperty).

Parameters:

id - a consumer that will call methods on ComponentProperty.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• id(ComponentProperty)

fields

ActionParameters.Builder fields(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.

state

ActionParameters.Builder state(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.

state

default ActionParameters.Builder state(Consumer<MutationActionSetStateParameter.Builder> state)

A key-value pair that specifies the state property name and its initial value.

This is a convenience method that creates an instance of the MutationActionSetStateParameter.Builder avoiding the need to create one manually via MutationActionSetStateParameter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to state(MutationActionSetStateParameter).

Parameters:

state - a consumer that will call methods on MutationActionSetStateParameter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• state(MutationActionSetStateParameter)