Interface ScheduleAction.Builder

All Superinterfaces:

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

Enclosing class:

ScheduleAction

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

Method Summary

Modifier and Type	Method	Description
ScheduleAction.Builder	actionName(String actionName)	The name of the schedule action.
default ScheduleAction.Builder	error(Consumer<ScheduleActionError.Builder> error)	A description of why the action failed.
ScheduleAction.Builder	error(ScheduleActionError error)	A description of why the action failed.
ScheduleAction.Builder	operations(Collection<ScheduleActionOperation> operations)	The configuration changes that the action makes to the feed.
ScheduleAction.Builder	operations(Consumer<ScheduleActionOperation.Builder>... operations)	The configuration changes that the action makes to the feed.
ScheduleAction.Builder	operations(ScheduleActionOperation... operations)	The configuration changes that the action makes to the feed.
default ScheduleAction.Builder	startConfiguration(Consumer<ScheduleActionStartConfiguration.Builder> startConfiguration)	Specifies when the action runs.
ScheduleAction.Builder	startConfiguration(ScheduleActionStartConfiguration startConfiguration)	Specifies when the action runs.
ScheduleAction.Builder	status(String status)	The status of the action.
ScheduleAction.Builder	status(ScheduleActionStatus status)	The status of the action.

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

actionName

ScheduleAction.Builder actionName(String actionName)

The name of the schedule action. The name is unique within the feed.

Parameters:

actionName - The name of the schedule action. The name is unique within the feed.

Returns:

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

startConfiguration

ScheduleAction.Builder startConfiguration(ScheduleActionStartConfiguration startConfiguration)

Specifies when the action runs.

Parameters:

startConfiguration - Specifies when the action runs.

Returns:

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

startConfiguration

default ScheduleAction.Builder startConfiguration(Consumer<ScheduleActionStartConfiguration.Builder> startConfiguration)

Specifies when the action runs.

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

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

Parameters:

startConfiguration - a consumer that will call methods on ScheduleActionStartConfiguration.Builder

Returns:

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

See Also:

• startConfiguration(ScheduleActionStartConfiguration)

operations

ScheduleAction.Builder operations(Collection<ScheduleActionOperation> operations)

The configuration changes that the action makes to the feed.

Parameters:

operations - The configuration changes that the action makes to the feed.

Returns:

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

operations

ScheduleAction.Builder operations(ScheduleActionOperation... operations)

The configuration changes that the action makes to the feed.

Parameters:

operations - The configuration changes that the action makes to the feed.

Returns:

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

operations

ScheduleAction.Builder operations(Consumer<ScheduleActionOperation.Builder>... operations)

The configuration changes that the action makes to the feed.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operations(List<ScheduleActionOperation>).

Parameters:

operations - a consumer that will call methods on ScheduleActionOperation.Builder

Returns:

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

See Also:

• operations(java.util.Collection<ScheduleActionOperation>)

status

ScheduleAction.Builder status(String status)

The status of the action. Valid values are the following:

PENDING

The action is waiting for its scheduled time.

COMPLETED

Elemental Inference applied all the action's operations to the feed.

FAILED

Elemental Inference couldn't apply the action.

Parameters:

status - The status of the action. Valid values are the following:

PENDING

The action is waiting for its scheduled time.

COMPLETED

Elemental Inference applied all the action's operations to the feed.

FAILED

Elemental Inference couldn't apply the action.

Returns:

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

See Also:

• ScheduleActionStatus
• ScheduleActionStatus

status

ScheduleAction.Builder status(ScheduleActionStatus status)

The status of the action. Valid values are the following:

PENDING

The action is waiting for its scheduled time.

COMPLETED

Elemental Inference applied all the action's operations to the feed.

FAILED

Elemental Inference couldn't apply the action.

Parameters:

status - The status of the action. Valid values are the following:

PENDING

The action is waiting for its scheduled time.

COMPLETED

Elemental Inference applied all the action's operations to the feed.

FAILED

Elemental Inference couldn't apply the action.

Returns:

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

See Also:

• ScheduleActionStatus
• ScheduleActionStatus

error

ScheduleAction.Builder error(ScheduleActionError error)

A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

Parameters:

error - A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

Returns:

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

error

default ScheduleAction.Builder error(Consumer<ScheduleActionError.Builder> error)

A description of why the action failed. Elemental Inference returns this property only when the status is FAILED.

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

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

Parameters:

error - a consumer that will call methods on ScheduleActionError.Builder

Returns:

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

See Also:

• error(ScheduleActionError)