software.amazon.awssdk.services.robomaker.model

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 and 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.
SimulationJob.Builder	failureBehavior(FailureBehavior failureBehavior) The failure behavior the simulation job.
SimulationJob.Builder	failureBehavior(String failureBehavior) The failure behavior the simulation job.
SimulationJob.Builder	failureCode(SimulationJobErrorCode failureCode) The failure code of the simulation job if it failed.
SimulationJob.Builder	failureCode(String failureCode) The failure code of the simulation job if it 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	lastUpdatedAt(Instant lastUpdatedAt) The time, in milliseconds since the epoch, when the simulation job was last updated.
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	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(SimulationJobStatus status) Status of the simulation job.
SimulationJob.Builder	status(String status) Status of 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.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

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

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

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

Parameters:

failureBehavior - The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

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

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

Parameters:

failureBehavior - The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

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

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 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)

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. See how to specify AWS security credentials for your application.

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. See how to specify AWS security credentials for your application.

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 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 #robotApplications(List).

Parameters:

robotApplications - 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:

#robotApplications(List)

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 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 #simulationApplications(List).

Parameters:

simulationApplications - 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:

#simulationApplications(List)

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 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)