Interface SimulationJob.Builder

All Superinterfaces:

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

Enclosing class:

SimulationJob

public static interface SimulationJob.Builder
extends SdkPojo, CopyableBuilder<SimulationJob.Builder,SimulationJob>

Method Summary

Modifier and Type	Method	Description
SimulationJob.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the simulation job.
SimulationJob.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for this SimulationJob request.
default SimulationJob.Builder	compute(Consumer<ComputeResponse.Builder> compute)	Compute information for the simulation job
SimulationJob.Builder	compute(ComputeResponse compute)	Compute information for the simulation job
SimulationJob.Builder	dataSources(Collection<DataSource> dataSources)	The data sources for the simulation job.
SimulationJob.Builder	dataSources(Consumer<DataSource.Builder>... dataSources)	The data sources for the simulation job.
SimulationJob.Builder	dataSources(DataSource... dataSources)	The data sources for the simulation job.
SimulationJob.Builder	failureBehavior(String failureBehavior)	The failure behavior the simulation job.
SimulationJob.Builder	failureBehavior(FailureBehavior failureBehavior)	The failure behavior the simulation job.
SimulationJob.Builder	failureCode(String failureCode)	The failure code of the simulation job if it failed.
SimulationJob.Builder	failureCode(SimulationJobErrorCode failureCode)	The failure code of the simulation job if it failed.
SimulationJob.Builder	failureReason(String failureReason)	The reason why the simulation job failed.
SimulationJob.Builder	iamRole(String iamRole)	The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
SimulationJob.Builder	lastStartedAt(Instant lastStartedAt)	The time, in milliseconds since the epoch, when the simulation job was last started.
SimulationJob.Builder	lastUpdatedAt(Instant lastUpdatedAt)	The time, in milliseconds since the epoch, when the simulation job was last updated.
default SimulationJob.Builder	loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)	The logging configuration.
SimulationJob.Builder	loggingConfig(LoggingConfig loggingConfig)	The logging configuration.
SimulationJob.Builder	maxJobDurationInSeconds(Long maxJobDurationInSeconds)	The maximum simulation job duration in seconds.
SimulationJob.Builder	name(String name)	The name of the simulation job.
default SimulationJob.Builder	networkInterface(Consumer<NetworkInterface.Builder> networkInterface)	Information about a network interface.
SimulationJob.Builder	networkInterface(NetworkInterface networkInterface)	Information about a network interface.
default SimulationJob.Builder	outputLocation(Consumer<OutputLocation.Builder> outputLocation)	Location for output files generated by the simulation job.
SimulationJob.Builder	outputLocation(OutputLocation outputLocation)	Location for output files generated by the simulation job.
SimulationJob.Builder	robotApplications(Collection<RobotApplicationConfig> robotApplications)	A list of robot applications.
SimulationJob.Builder	robotApplications(Consumer<RobotApplicationConfig.Builder>... robotApplications)	A list of robot applications.
SimulationJob.Builder	robotApplications(RobotApplicationConfig... robotApplications)	A list of robot applications.
SimulationJob.Builder	simulationApplications(Collection<SimulationApplicationConfig> simulationApplications)	A list of simulation applications.
SimulationJob.Builder	simulationApplications(Consumer<SimulationApplicationConfig.Builder>... simulationApplications)	A list of simulation applications.
SimulationJob.Builder	simulationApplications(SimulationApplicationConfig... simulationApplications)	A list of simulation applications.
SimulationJob.Builder	simulationTimeMillis(Long simulationTimeMillis)	The simulation job execution duration in milliseconds.
SimulationJob.Builder	status(String status)	Status of the simulation job.
SimulationJob.Builder	status(SimulationJobStatus status)	Status of the simulation job.
SimulationJob.Builder	tags(Map<String,String> tags)	A map that contains tag keys and tag values that are attached to the simulation job.
default SimulationJob.Builder	vpcConfig(Consumer<VPCConfigResponse.Builder> vpcConfig)	VPC configuration information.
SimulationJob.Builder	vpcConfig(VPCConfigResponse vpcConfig)	VPC configuration information.

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, sdkFields

Method Details

arn

SimulationJob.Builder arn(String arn)

The Amazon Resource Name (ARN) of the simulation job.

Parameters:

arn - The Amazon Resource Name (ARN) of the simulation job.

Returns:

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

name

SimulationJob.Builder name(String name)

The name of the simulation job.

Parameters:

name - The name of the simulation job.

Returns:

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

status

SimulationJob.Builder status(String status)

Status of the simulation job.

Parameters:

status - Status of the simulation job.

Returns:

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

See Also:

• SimulationJobStatus
• SimulationJobStatus

status

SimulationJob.Builder status(SimulationJobStatus status)

Status of the simulation job.

Parameters:

status - Status of the simulation job.

Returns:

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

See Also:

• SimulationJobStatus
• SimulationJobStatus

lastStartedAt

SimulationJob.Builder lastStartedAt(Instant lastStartedAt)

The time, in milliseconds since the epoch, when the simulation job was last started.

Parameters:

lastStartedAt - The time, in milliseconds since the epoch, when the simulation job was last started.

Returns:

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

lastUpdatedAt

SimulationJob.Builder lastUpdatedAt(Instant lastUpdatedAt)

The time, in milliseconds since the epoch, when the simulation job was last updated.

Parameters:

lastUpdatedAt - The time, in milliseconds since the epoch, when the simulation job was last updated.

Returns:

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

failureBehavior

SimulationJob.Builder failureBehavior(String failureBehavior)

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

Parameters:

failureBehavior - The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

Returns:

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

See Also:

• FailureBehavior
• FailureBehavior

failureBehavior

SimulationJob.Builder failureBehavior(FailureBehavior failureBehavior)

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

Parameters:

failureBehavior - The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

Returns:

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

See Also:

• FailureBehavior
• FailureBehavior

failureCode

SimulationJob.Builder failureCode(String failureCode)

The failure code of the simulation job if it failed.

Parameters:

failureCode - The failure code of the simulation job if it failed.

Returns:

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

See Also:

• SimulationJobErrorCode
• SimulationJobErrorCode

failureCode

SimulationJob.Builder failureCode(SimulationJobErrorCode failureCode)

The failure code of the simulation job if it failed.

Parameters:

failureCode - The failure code of the simulation job if it failed.

Returns:

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

See Also:

• SimulationJobErrorCode
• SimulationJobErrorCode

failureReason

SimulationJob.Builder failureReason(String failureReason)

The reason why the simulation job failed.

Parameters:

failureReason - The reason why the simulation job failed.

Returns:

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

clientRequestToken

SimulationJob.Builder clientRequestToken(String clientRequestToken)

A unique identifier for this SimulationJob request.

Parameters:

clientRequestToken - A unique identifier for this SimulationJob request.

Returns:

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

outputLocation

SimulationJob.Builder outputLocation(OutputLocation outputLocation)

Location for output files generated by the simulation job.

Parameters:

outputLocation - Location for output files generated by the simulation job.

Returns:

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

outputLocation

default SimulationJob.Builder outputLocation(Consumer<OutputLocation.Builder> outputLocation)

Location for output files generated by the simulation job.

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

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

Parameters:

outputLocation - a consumer that will call methods on OutputLocation.Builder

Returns:

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

See Also:

• outputLocation(OutputLocation)

loggingConfig

SimulationJob.Builder loggingConfig(LoggingConfig loggingConfig)

The logging configuration.

Parameters:

loggingConfig - The logging configuration.

Returns:

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

loggingConfig

default SimulationJob.Builder loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)

The logging configuration.

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

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

Parameters:

loggingConfig - a consumer that will call methods on LoggingConfig.Builder

Returns:

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

See Also:

• loggingConfig(LoggingConfig)

maxJobDurationInSeconds

SimulationJob.Builder maxJobDurationInSeconds(Long maxJobDurationInSeconds)

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Parameters:

maxJobDurationInSeconds - The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Returns:

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

simulationTimeMillis

SimulationJob.Builder simulationTimeMillis(Long simulationTimeMillis)

The simulation job execution duration in milliseconds.

Parameters:

simulationTimeMillis - The simulation job execution duration in milliseconds.

Returns:

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

iamRole

SimulationJob.Builder iamRole(String iamRole)

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Parameters:

iamRole - The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Returns:

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

robotApplications

SimulationJob.Builder robotApplications(Collection<RobotApplicationConfig> robotApplications)

A list of robot applications.

Parameters:

robotApplications - A list of robot applications.

Returns:

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

robotApplications

SimulationJob.Builder robotApplications(RobotApplicationConfig... robotApplications)

A list of robot applications.

Parameters:

robotApplications - A list of robot applications.

Returns:

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

robotApplications

SimulationJob.Builder robotApplications(Consumer<RobotApplicationConfig.Builder>... robotApplications)

A list of robot applications.

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

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

Parameters:

robotApplications - a consumer that will call methods on RobotApplicationConfig.Builder

Returns:

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

See Also:

• robotApplications(java.util.Collection<RobotApplicationConfig>)

simulationApplications

SimulationJob.Builder simulationApplications(Collection<SimulationApplicationConfig> simulationApplications)

A list of simulation applications.

Parameters:

simulationApplications - A list of simulation applications.

Returns:

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

simulationApplications

SimulationJob.Builder simulationApplications(SimulationApplicationConfig... simulationApplications)

A list of simulation applications.

Parameters:

simulationApplications - A list of simulation applications.

Returns:

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

simulationApplications

SimulationJob.Builder simulationApplications(Consumer<SimulationApplicationConfig.Builder>... simulationApplications)

A list of simulation applications.

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

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

Parameters:

simulationApplications - a consumer that will call methods on SimulationApplicationConfig.Builder

Returns:

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

See Also:

• simulationApplications(java.util.Collection<SimulationApplicationConfig>)

dataSources

SimulationJob.Builder dataSources(Collection<DataSource> dataSources)

The data sources for the simulation job.

Parameters:

dataSources - The data sources for the simulation job.

Returns:

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

dataSources

SimulationJob.Builder dataSources(DataSource... dataSources)

The data sources for the simulation job.

Parameters:

dataSources - The data sources for the simulation job.

Returns:

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

dataSources

SimulationJob.Builder dataSources(Consumer<DataSource.Builder>... dataSources)

The data sources for the simulation job.

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

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

Parameters:

dataSources - a consumer that will call methods on DataSource.Builder

Returns:

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

See Also:

• dataSources(java.util.Collection<DataSource>)

tags

SimulationJob.Builder tags(Map<String,String> tags)

A map that contains tag keys and tag values that are attached to the simulation job.

Parameters:

tags - A map that contains tag keys and tag values that are attached to the simulation job.

Returns:

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

vpcConfig

SimulationJob.Builder vpcConfig(VPCConfigResponse vpcConfig)

VPC configuration information.

Parameters:

vpcConfig - VPC configuration information.

Returns:

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

vpcConfig

default SimulationJob.Builder vpcConfig(Consumer<VPCConfigResponse.Builder> vpcConfig)

VPC configuration information.

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

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

Parameters:

vpcConfig - a consumer that will call methods on VPCConfigResponse.Builder

Returns:

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

See Also:

• vpcConfig(VPCConfigResponse)

networkInterface

SimulationJob.Builder networkInterface(NetworkInterface networkInterface)

Information about a network interface.

Parameters:

networkInterface - Information about a network interface.

Returns:

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

networkInterface

default SimulationJob.Builder networkInterface(Consumer<NetworkInterface.Builder> networkInterface)

Information about a network interface.

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

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

Parameters:

networkInterface - a consumer that will call methods on NetworkInterface.Builder

Returns:

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

See Also:

• networkInterface(NetworkInterface)

compute

SimulationJob.Builder compute(ComputeResponse compute)

Compute information for the simulation job

Parameters:

compute - Compute information for the simulation job

Returns:

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

compute

default SimulationJob.Builder compute(Consumer<ComputeResponse.Builder> compute)

Compute information for the simulation job

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

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

Parameters:

compute - a consumer that will call methods on ComputeResponse.Builder

Returns:

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

See Also:

• compute(ComputeResponse)