CreateSimulationJobRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.robomaker.model.RoboMakerRequest
    - - software.amazon.awssdk.services.robomaker.model.CreateSimulationJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateSimulationJobRequest
extends RoboMakerRequest
implements ToCopyableBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateSimulationJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateSimulationJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateSimulationJobRequest.Builder`	`builder()`
`String`	`clientRequestToken()` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`boolean`	`equals(Object obj)`
`FailureBehavior`	`failureBehavior()` The failure behavior the simulation job.
`String`	`failureBehaviorAsString()` The failure behavior the simulation job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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.
`Long`	`maxJobDurationInSeconds()` The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds.
`OutputLocation`	`outputLocation()` Location for output files generated by the simulation job.
`List<RobotApplicationConfig>`	`robotApplications()` The robot application to use in the simulation job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateSimulationJobRequest.Builder>`	`serializableBuilderClass()`
`List<SimulationApplicationConfig>`	`simulationApplications()` The simulation application to use in the simulation job.
`CreateSimulationJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`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 software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientRequestToken
```
public String clientRequestToken()
```
    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.
  - outputLocation
```
public OutputLocation outputLocation()
```
    Location for output files generated by the simulation job.
    
    Returns:
    
    Location for output files generated by the simulation job.
  - maxJobDurationInSeconds
```
public 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.
    
    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.
  - iamRole
```
public 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.
    
    Returns:
    
    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.
  - failureBehavior
```
public 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.
    
    If the service returns an enum value that is not available in the current SDK version, failureBehavior will return FailureBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureBehaviorAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    FailureBehavior
  - failureBehaviorAsString
```
public String failureBehaviorAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, failureBehavior will return FailureBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureBehaviorAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    FailureBehavior
  - robotApplications
```
public List<RobotApplicationConfig> robotApplications()
```
    The robot application to use in the simulation job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The robot application to use in the simulation job.
  - simulationApplications
```
public List<SimulationApplicationConfig> simulationApplications()
```
    The simulation application to use in the simulation job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The simulation application to use in the simulation job.
  - vpcConfig
```
public 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.
    
    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.
  - toBuilder
```
public CreateSimulationJobRequest.Builder 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 interface ToCopyableBuilder<CreateSimulationJobRequest.Builder,CreateSimulationJobRequest>
    
    Specified by:
    
    toBuilder in class RoboMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateSimulationJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateSimulationJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateSimulationJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

clientRequestToken

outputLocation

maxJobDurationInSeconds

iamRole

failureBehavior

failureBehaviorAsString

robotApplications

simulationApplications

vpcConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields