com.amazonaws.services.robomaker.model

Class CreateSimulationJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.robomaker.model.CreateSimulationJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSimulationJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateSimulationJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateSimulationJobRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateSimulationJobRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateSimulationJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Compute	getCompute() Compute information for the simulation job.
List<DataSourceConfig>	getDataSources() Specify data sources to mount read-only files from S3 into your simulation.
String	getFailureBehavior() The failure behavior the simulation job.
String	getIamRole() The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
LoggingConfig	getLoggingConfig() The logging configuration.
Long	getMaxJobDurationInSeconds() The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds.
OutputLocation	getOutputLocation() Location for output files generated by the simulation job.
List<RobotApplicationConfig>	getRobotApplications() The robot application to use in the simulation job.
List<SimulationApplicationConfig>	getSimulationApplications() The simulation application to use in the simulation job.
Map<String,String>	getTags() A map that contains tag keys and tag values that are attached to the simulation job.
VPCConfig	getVpcConfig() If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setCompute(Compute compute) Compute information for the simulation job.
void	setDataSources(Collection<DataSourceConfig> dataSources) Specify data sources to mount read-only files from S3 into your simulation.
void	setFailureBehavior(String failureBehavior) The failure behavior the simulation job.
void	setIamRole(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.
void	setLoggingConfig(LoggingConfig loggingConfig) The logging configuration.
void	setMaxJobDurationInSeconds(Long maxJobDurationInSeconds) The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds.
void	setOutputLocation(OutputLocation outputLocation) Location for output files generated by the simulation job.
void	setRobotApplications(Collection<RobotApplicationConfig> robotApplications) The robot application to use in the simulation job.
void	setSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications) The simulation application to use in the simulation job.
void	setTags(Map<String,String> tags) A map that contains tag keys and tag values that are attached to the simulation job.
void	setVpcConfig(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.
String	toString() Returns a string representation of this object.
CreateSimulationJobRequest	withClientRequestToken(String clientRequestToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateSimulationJobRequest	withCompute(Compute compute) Compute information for the simulation job.
CreateSimulationJobRequest	withDataSources(Collection<DataSourceConfig> dataSources) Specify data sources to mount read-only files from S3 into your simulation.
CreateSimulationJobRequest	withDataSources(DataSourceConfig... dataSources) Specify data sources to mount read-only files from S3 into your simulation.
CreateSimulationJobRequest	withFailureBehavior(FailureBehavior failureBehavior) The failure behavior the simulation job.
CreateSimulationJobRequest	withFailureBehavior(String failureBehavior) The failure behavior the simulation job.
CreateSimulationJobRequest	withIamRole(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.
CreateSimulationJobRequest	withLoggingConfig(LoggingConfig loggingConfig) The logging configuration.
CreateSimulationJobRequest	withMaxJobDurationInSeconds(Long maxJobDurationInSeconds) The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds.
CreateSimulationJobRequest	withOutputLocation(OutputLocation outputLocation) Location for output files generated by the simulation job.
CreateSimulationJobRequest	withRobotApplications(Collection<RobotApplicationConfig> robotApplications) The robot application to use in the simulation job.
CreateSimulationJobRequest	withRobotApplications(RobotApplicationConfig... robotApplications) The robot application to use in the simulation job.
CreateSimulationJobRequest	withSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications) The simulation application to use in the simulation job.
CreateSimulationJobRequest	withSimulationApplications(SimulationApplicationConfig... simulationApplications) The simulation application to use in the simulation job.
CreateSimulationJobRequest	withTags(Map<String,String> tags) A map that contains tag keys and tag values that are attached to the simulation job.
CreateSimulationJobRequest	withVpcConfig(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 class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateSimulationJobRequest

public CreateSimulationJobRequest()

Method Detail

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public CreateSimulationJobRequest withClientRequestToken(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.

setOutputLocation

public void setOutputLocation(OutputLocation outputLocation)

Location for output files generated by the simulation job.

Parameters:

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

getOutputLocation

public OutputLocation getOutputLocation()

Location for output files generated by the simulation job.

Returns:

Location for output files generated by the simulation job.

withOutputLocation

public CreateSimulationJobRequest withOutputLocation(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.

setLoggingConfig

public void setLoggingConfig(LoggingConfig loggingConfig)

The logging configuration.

Parameters:

loggingConfig - The logging configuration.

getLoggingConfig

public LoggingConfig getLoggingConfig()

The logging configuration.

Returns:

The logging configuration.

withLoggingConfig

public CreateSimulationJobRequest withLoggingConfig(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.

setMaxJobDurationInSeconds

public void setMaxJobDurationInSeconds(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.

getMaxJobDurationInSeconds

public Long getMaxJobDurationInSeconds()

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:

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.

withMaxJobDurationInSeconds

public CreateSimulationJobRequest withMaxJobDurationInSeconds(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.

setIamRole

public void setIamRole(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.

getIamRole

public String getIamRole()

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:

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.

withIamRole

public CreateSimulationJobRequest withIamRole(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.

setFailureBehavior

public void setFailureBehavior(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.

See Also:

FailureBehavior

getFailureBehavior

public String getFailureBehavior()

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:

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.

See Also:

FailureBehavior

withFailureBehavior

public CreateSimulationJobRequest withFailureBehavior(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

withFailureBehavior

public CreateSimulationJobRequest withFailureBehavior(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

getRobotApplications

public List<RobotApplicationConfig> getRobotApplications()

The robot application to use in the simulation job.

Returns:

The robot application to use in the simulation job.

setRobotApplications

public void setRobotApplications(Collection<RobotApplicationConfig> robotApplications)

The robot application to use in the simulation job.

Parameters:

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

withRobotApplications

public CreateSimulationJobRequest withRobotApplications(RobotApplicationConfig... robotApplications)

The robot application to use in the simulation job.

NOTE: This method appends the values to the existing list (if any). Use setRobotApplications(java.util.Collection) or withRobotApplications(java.util.Collection) if you want to override the existing values.

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.

withRobotApplications

public CreateSimulationJobRequest withRobotApplications(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.

getSimulationApplications

public List<SimulationApplicationConfig> getSimulationApplications()

The simulation application to use in the simulation job.

Returns:

The simulation application to use in the simulation job.

setSimulationApplications

public void setSimulationApplications(Collection<SimulationApplicationConfig> simulationApplications)

The simulation application to use in the simulation job.

Parameters:

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

withSimulationApplications

public CreateSimulationJobRequest withSimulationApplications(SimulationApplicationConfig... simulationApplications)

The simulation application to use in the simulation job.

NOTE: This method appends the values to the existing list (if any). Use setSimulationApplications(java.util.Collection) or withSimulationApplications(java.util.Collection) if you want to override the existing values.

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.

withSimulationApplications

public CreateSimulationJobRequest withSimulationApplications(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.

getDataSources

public List<DataSourceConfig> getDataSources()

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:

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.

setDataSources

public void setDataSources(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.

withDataSources

public CreateSimulationJobRequest withDataSources(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.

NOTE: This method appends the values to the existing list (if any). Use setDataSources(java.util.Collection) or withDataSources(java.util.Collection) if you want to override the existing values.

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.

withDataSources

public CreateSimulationJobRequest withDataSources(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.

getTags

public Map<String,String> getTags()

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

Returns:

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

setTags

public void setTags(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.

withTags

public CreateSimulationJobRequest withTags(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.

addTagsEntry

public CreateSimulationJobRequest addTagsEntry(String key,
                                               String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateSimulationJobRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setVpcConfig

public void setVpcConfig(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.

getVpcConfig

public VPCConfig getVpcConfig()

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:

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.

withVpcConfig

public CreateSimulationJobRequest withVpcConfig(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.

setCompute

public void setCompute(Compute compute)

Compute information for the simulation job.

Parameters:

compute - Compute information for the simulation job.

getCompute

public Compute getCompute()

Compute information for the simulation job.

Returns:

Compute information for the simulation job.

withCompute

public CreateSimulationJobRequest withCompute(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateSimulationJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()