Class SimulationJobRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SimulationJobRequest.Builder,
SimulationJobRequest>
Information about a simulation job request.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SimulationJobRequest.Builder
builder()
final Compute
compute()
Compute information for the simulation jobfinal List
<DataSourceConfig> Specify data sources to mount read-only files from S3 into your simulation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FailureBehavior
The failure behavior the simulation job.final String
The failure behavior the simulation job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DataSources property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RobotApplications property.final boolean
For responses, this returns true if the service returned a value for the SimulationApplications property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final 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.final LoggingConfig
Returns the value of the LoggingConfig property for this object.final Long
The maximum simulation job duration in seconds.final OutputLocation
Returns the value of the OutputLocation property for this object.final List
<RobotApplicationConfig> The robot applications to use in the simulation job.static Class
<? extends SimulationJobRequest.Builder> final List
<SimulationApplicationConfig> The simulation applications to use in the simulation job.tags()
A map that contains tag keys and tag values that are attached to the simulation job request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
A Boolean indicating whether to use default applications in the simulation job.final VPCConfig
Returns the value of the VpcConfig property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
outputLocation
Returns the value of the OutputLocation property for this object.- Returns:
- The value of the OutputLocation property for this object.
-
loggingConfig
Returns the value of the LoggingConfig property for this object.- Returns:
- The value of the LoggingConfig property for this object.
-
maxJobDurationInSeconds
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
- Returns:
- The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
-
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:
- 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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
failureBehavior
will returnFailureBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureBehaviorAsString()
.- Returns:
- 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.
- See Also:
-
failureBehaviorAsString
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.
If the service returns an enum value that is not available in the current SDK version,
failureBehavior
will returnFailureBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureBehaviorAsString()
.- Returns:
- 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.
- See Also:
-
useDefaultApplications
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
- Returns:
- A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
-
hasRobotApplications
public final boolean hasRobotApplications()For responses, this returns true if the service returned a value for the RobotApplications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
robotApplications
The robot applications to use in the simulation job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRobotApplications()
method.- Returns:
- The robot applications to use in the simulation job.
-
hasSimulationApplications
public final boolean hasSimulationApplications()For responses, this returns true if the service returned a value for the SimulationApplications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
simulationApplications
The simulation applications to use in the simulation job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSimulationApplications()
method.- Returns:
- The simulation applications to use in the simulation job.
-
hasDataSources
public final boolean hasDataSources()For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDataSources()
method.- 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.
-
vpcConfig
Returns the value of the VpcConfig property for this object.- Returns:
- The value of the VpcConfig property for this object.
-
compute
Compute information for the simulation job
- Returns:
- Compute information for the simulation job
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
A map that contains tag keys and tag values that are attached to the simulation job request.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- A map that contains tag keys and tag values that are attached to the simulation job request.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SimulationJobRequest.Builder,
SimulationJobRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-