software.amazon.awssdk.services.ssm.model

Interface AutomationExecution.Builder

All Superinterfaces:

CopyableBuilder<AutomationExecution.Builder,AutomationExecution>, SdkBuilder<AutomationExecution.Builder,AutomationExecution>

Enclosing class:

AutomationExecution

public static interface AutomationExecution.Builder
extends CopyableBuilder<AutomationExecution.Builder,AutomationExecution>

Method Summary

Modifier and Type	Method and Description
AutomationExecution.Builder	automationExecutionId(String automationExecutionId) The execution ID.
AutomationExecution.Builder	automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus) The execution status of the Automation.
AutomationExecution.Builder	automationExecutionStatus(String automationExecutionStatus) The execution status of the Automation.
AutomationExecution.Builder	documentName(String documentName) The name of the Automation document used during the execution.
AutomationExecution.Builder	documentVersion(String documentVersion) The version of the document to use during execution.
AutomationExecution.Builder	executionEndTime(Instant executionEndTime) The time the execution finished.
AutomationExecution.Builder	executionStartTime(Instant executionStartTime) The time the execution started.
AutomationExecution.Builder	failureMessage(String failureMessage) A message describing why an execution has failed, if the status is set to Failed.
AutomationExecution.Builder	outputs(Map<String,? extends Collection<String>> outputs) The list of execution outputs as defined in the automation document.
AutomationExecution.Builder	parameters(Map<String,? extends Collection<String>> parameters) The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.
AutomationExecution.Builder	stepExecutions(Collection<StepExecution> stepExecutions) A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	stepExecutions(Consumer<StepExecution.Builder>... stepExecutions) A list of details about the current state of all steps that comprise an execution.
AutomationExecution.Builder	stepExecutions(StepExecution... stepExecutions) A list of details about the current state of all steps that comprise an execution.

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

copy

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

apply, build

Method Detail

automationExecutionId

AutomationExecution.Builder automationExecutionId(String automationExecutionId)

The execution ID.

Parameters:

automationExecutionId - The execution ID.

Returns:

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

documentName

AutomationExecution.Builder documentName(String documentName)

The name of the Automation document used during the execution.

Parameters:

documentName - The name of the Automation document used during the execution.

Returns:

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

documentVersion

AutomationExecution.Builder documentVersion(String documentVersion)

The version of the document to use during execution.

Parameters:

documentVersion - The version of the document to use during execution.

Returns:

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

executionStartTime

AutomationExecution.Builder executionStartTime(Instant executionStartTime)

The time the execution started.

Parameters:

executionStartTime - The time the execution started.

Returns:

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

executionEndTime

AutomationExecution.Builder executionEndTime(Instant executionEndTime)

The time the execution finished.

Parameters:

executionEndTime - The time the execution finished.

Returns:

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

automationExecutionStatus

AutomationExecution.Builder automationExecutionStatus(String automationExecutionStatus)

The execution status of the Automation.

Parameters:

automationExecutionStatus - The execution status of the Automation.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

automationExecutionStatus

AutomationExecution.Builder automationExecutionStatus(AutomationExecutionStatus automationExecutionStatus)

The execution status of the Automation.

Parameters:

automationExecutionStatus - The execution status of the Automation.

Returns:

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

See Also:

AutomationExecutionStatus, AutomationExecutionStatus

stepExecutions

AutomationExecution.Builder stepExecutions(Collection<StepExecution> stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Parameters:

stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Returns:

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

stepExecutions

AutomationExecution.Builder stepExecutions(StepExecution... stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Parameters:

stepExecutions - A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

Returns:

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

stepExecutions

AutomationExecution.Builder stepExecutions(Consumer<StepExecution.Builder>... stepExecutions)

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #stepExecutions(List).

Parameters:

stepExecutions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#stepExecutions(List)

parameters

AutomationExecution.Builder parameters(Map<String,? extends Collection<String>> parameters)

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Parameters:

parameters - The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

Returns:

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

outputs

AutomationExecution.Builder outputs(Map<String,? extends Collection<String>> outputs)

The list of execution outputs as defined in the automation document.

Parameters:

outputs - The list of execution outputs as defined in the automation document.

Returns:

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

failureMessage

AutomationExecution.Builder failureMessage(String failureMessage)

A message describing why an execution has failed, if the status is set to Failed.

Parameters:

failureMessage - A message describing why an execution has failed, if the status is set to Failed.

Returns:

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