Package software.amazon.awssdk.services.robomaker.model

Interface CreateSimulationJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>, RoboMakerRequest.Builder, SdkBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSimulationJobRequest

public static interface CreateSimulationJobRequest.Builder
extends RoboMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>

Method Summary

Modifier and Type	Method	Description
CreateSimulationJobRequest.Builder	clientRequestToken(String clientRequestToken)	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default CreateSimulationJobRequest.Builder	compute(Consumer<Compute.Builder> compute)	Compute information for the simulation job.
CreateSimulationJobRequest.Builder	compute(Compute compute)	Compute information for the simulation job.
CreateSimulationJobRequest.Builder	dataSources(Collection<DataSourceConfig> dataSources)	Specify data sources to mount read-only files from S3 into your simulation.
CreateSimulationJobRequest.Builder	dataSources(Consumer<DataSourceConfig.Builder>... dataSources)	Specify data sources to mount read-only files from S3 into your simulation.
CreateSimulationJobRequest.Builder	dataSources(DataSourceConfig... dataSources)	Specify data sources to mount read-only files from S3 into your simulation.
CreateSimulationJobRequest.Builder	failureBehavior(String failureBehavior)	The failure behavior the simulation job.
CreateSimulationJobRequest.Builder	failureBehavior(FailureBehavior failureBehavior)	The failure behavior the simulation job.
CreateSimulationJobRequest.Builder	iamRole(String iamRole)	The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
default CreateSimulationJobRequest.Builder	loggingConfig(Consumer<LoggingConfig.Builder> loggingConfig)	The logging configuration.
CreateSimulationJobRequest.Builder	loggingConfig(LoggingConfig loggingConfig)	The logging configuration.
CreateSimulationJobRequest.Builder	maxJobDurationInSeconds(Long maxJobDurationInSeconds)	The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds.
default CreateSimulationJobRequest.Builder	outputLocation(Consumer<OutputLocation.Builder> outputLocation)	Location for output files generated by the simulation job.
CreateSimulationJobRequest.Builder	outputLocation(OutputLocation outputLocation)	Location for output files generated by the simulation job.
CreateSimulationJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateSimulationJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateSimulationJobRequest.Builder	robotApplications(Collection<RobotApplicationConfig> robotApplications)	The robot application to use in the simulation job.
CreateSimulationJobRequest.Builder	robotApplications(Consumer<RobotApplicationConfig.Builder>... robotApplications)	The robot application to use in the simulation job.
CreateSimulationJobRequest.Builder	robotApplications(RobotApplicationConfig... robotApplications)	The robot application to use in the simulation job.
CreateSimulationJobRequest.Builder	simulationApplications(Collection<SimulationApplicationConfig> simulationApplications)	The simulation application to use in the simulation job.
CreateSimulationJobRequest.Builder	simulationApplications(Consumer<SimulationApplicationConfig.Builder>... simulationApplications)	The simulation application to use in the simulation job.
CreateSimulationJobRequest.Builder	simulationApplications(SimulationApplicationConfig... simulationApplications)	The simulation application to use in the simulation job.
CreateSimulationJobRequest.Builder	tags(Map<String,String> tags)	A map that contains tag keys and tag values that are attached to the simulation job.
default CreateSimulationJobRequest.Builder	vpcConfig(Consumer<VPCConfig.Builder> vpcConfig)	If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.
CreateSimulationJobRequest.Builder	vpcConfig(VPCConfig vpcConfig)	If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.robomaker.model.RoboMakerRequest.Builder

build

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

clientRequestToken

CreateSimulationJobRequest.Builder clientRequestToken(String clientRequestToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameters:

clientRequestToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

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

outputLocation

CreateSimulationJobRequest.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 CreateSimulationJobRequest.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

CreateSimulationJobRequest.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 CreateSimulationJobRequest.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

CreateSimulationJobRequest.Builder maxJobDurationInSeconds(Long maxJobDurationInSeconds)

The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

Parameters:

maxJobDurationInSeconds - The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

Returns:

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

iamRole

CreateSimulationJobRequest.Builder iamRole(String iamRole)

The IAM role name 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 name 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.

failureBehavior

CreateSimulationJobRequest.Builder failureBehavior(String failureBehavior)

The failure behavior the simulation job.

Continue

Leaves the instance 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 instance 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

CreateSimulationJobRequest.Builder failureBehavior(FailureBehavior failureBehavior)

The failure behavior the simulation job.

Continue

Leaves the instance 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 instance 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

robotApplications

CreateSimulationJobRequest.Builder robotApplications(Collection<RobotApplicationConfig> robotApplications)

The robot application to use in the simulation job.

Parameters:

robotApplications - The robot application to use in the simulation job.

Returns:

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

robotApplications

CreateSimulationJobRequest.Builder robotApplications(RobotApplicationConfig... robotApplications)

The robot application to use in the simulation job.

Parameters:

robotApplications - The robot application to use in the simulation job.

Returns:

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

robotApplications

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

The robot application to use in the simulation job.

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

CreateSimulationJobRequest.Builder simulationApplications(Collection<SimulationApplicationConfig> simulationApplications)

The simulation application to use in the simulation job.

Parameters:

simulationApplications - The simulation application to use in the simulation job.

Returns:

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

simulationApplications

CreateSimulationJobRequest.Builder simulationApplications(SimulationApplicationConfig... simulationApplications)

The simulation application to use in the simulation job.

Parameters:

simulationApplications - The simulation application to use in the simulation job.

Returns:

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

simulationApplications

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

The simulation application to use in the simulation job.

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

CreateSimulationJobRequest.Builder dataSources(Collection<DataSourceConfig> dataSources)

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Parameters:

dataSources - Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Returns:

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

dataSources

CreateSimulationJobRequest.Builder dataSources(DataSourceConfig... dataSources)

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Parameters:

dataSources - Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Returns:

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

dataSources

CreateSimulationJobRequest.Builder dataSources(Consumer<DataSourceConfig.Builder>... dataSources)

Specify data sources to mount read-only files from S3 into your simulation. These files are available under /opt/robomaker/datasources/data_source_name.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

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

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

Parameters:

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

Returns:

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

See Also:

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

tags

CreateSimulationJobRequest.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

CreateSimulationJobRequest.Builder vpcConfig(VPCConfig vpcConfig)

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

Parameters:

vpcConfig - If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

Returns:

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

vpcConfig

default CreateSimulationJobRequest.Builder vpcConfig(Consumer<VPCConfig.Builder> vpcConfig)

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

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

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

Parameters:

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

Returns:

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

See Also:

• vpcConfig(VPCConfig)

compute

CreateSimulationJobRequest.Builder compute(Compute 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 CreateSimulationJobRequest.Builder compute(Consumer<Compute.Builder> compute)

Compute information for the simulation job.

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

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

Parameters:

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

Returns:

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

See Also:

• compute(Compute)

overrideConfiguration

CreateSimulationJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateSimulationJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.