DescribeSimulationJobResponse (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
    - - software.amazon.awssdk.services.robomaker.model.DescribeSimulationJobResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSimulationJobResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the simulation job.
`static DescribeSimulationJobResponse.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 for the simulation job.
`String`	`failureBehaviorAsString()` The failure behavior for the simulation job.
`SimulationJobErrorCode`	`failureCode()` The failure code of the simulation job if it failed:
`String`	`failureCodeAsString()` The failure code of the simulation job if it failed:
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`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.
`Instant`	`lastUpdatedAt()` The time, in milliseconds since the epoch, when the simulation job was last updated.
`Long`	`maxJobDurationInSeconds()` The maximum job duration in seconds.
`String`	`name()` The name of the simulation job.
`OutputLocation`	`outputLocation()` Location for output files generated by the simulation job.
`List<RobotApplicationConfig>`	`robotApplications()` A list of robot applications.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeSimulationJobResponse.Builder>`	`serializableBuilderClass()`
`List<SimulationApplicationConfig>`	`simulationApplications()` A list of simulation applications.
`Long`	`simulationTimeMillis()` The simulation job execution duration in milliseconds.
`SimulationJobStatus`	`status()` The status of the simulation job.
`String`	`statusAsString()` The status of the simulation job.
`DescribeSimulationJobResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`VPCConfigResponse`	`vpcConfig()` The VPC configuration.

Methods inherited from class software.amazon.awssdk.services.robomaker.model.RoboMakerResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the simulation job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the simulation job.
  - name
```
public String name()
```
    The name of the simulation job.
    
    Returns:
    
    The name of the simulation job.
  - status
```
public SimulationJobStatus status()
```
    The status of the simulation job.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SimulationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the simulation job.
    
    See Also:
    
    SimulationJobStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the simulation job.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SimulationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the simulation job.
    
    See Also:
    
    SimulationJobStatus
  - lastUpdatedAt
```
public Instant lastUpdatedAt()
```
    The time, in milliseconds since the epoch, when the simulation job was last updated.
    
    Returns:
    
    The time, in milliseconds since the epoch, when the simulation job was last updated.
  - failureBehavior
```
public FailureBehavior failureBehavior()
```
    The failure behavior for the simulation job.
    
    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 for the simulation job.
    
    See Also:
    
    FailureBehavior
  - failureBehaviorAsString
```
public String failureBehaviorAsString()
```
    The failure behavior for the simulation job.
    
    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 for the simulation job.
    
    See Also:
    
    FailureBehavior
  - failureCode
```
public SimulationJobErrorCode failureCode()
```
    The failure code of the simulation job if it failed:
    
    InternalServiceError
    
    Internal service error
    
    RobotApplicationCrash
    
    Robot application exited abnormally (segfault, etc.)
    
    SimulationApplicationCrash
    
    Simulation application exited abnormally (segfault, etc.)
    
    BadPermissionsRobotApplication
    
    Robot application bundle could not be downloaded
    
    BadPermissionsSimulationApplication
    
    Simulation application bundle could not be downloaded
    
    BadPermissionsS3Output
    
    Unable to publish outputs to customer-provided S3 bucket
    
    BadPermissionsCloudwatchLogs
    
    Unable to publish logs to customer-provided CloudWatch Logs resource
    
    SubnetIpLimitExceeded
    
    Subnet IP limit exceeded
    
    ENILimitExceeded
    
    ENI limit exceeded
    
    BadPermissionsUserCredentials
    
    Unable to use the Role provided
    
    InvalidBundleRobotApplication
    
    Robot bundle cannot be extracted (invalid format, bundling error, etc.)
    
    InvalidBundleSimulationApplication
    
    Simulation bundle cannot be extracted (invalid format, bundling error, etc.)
    
    RobotApplicationVersionMismatchedEtag
    
    Etag for RobotApplication does not match value during version creation
    
    SimulationApplicationVersionMismatchedEtag
    
    Etag for SimulationApplication does not match value during version creation
    
    If the service returns an enum value that is not available in the current SDK version, failureCode will return SimulationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().
    
    Returns:
    
    The failure code of the simulation job if it failed:
    
    InternalServiceError
    
    Internal service error
    
    RobotApplicationCrash
    
    Robot application exited abnormally (segfault, etc.)
    
    SimulationApplicationCrash
    
    Simulation application exited abnormally (segfault, etc.)
    
    BadPermissionsRobotApplication
    
    Robot application bundle could not be downloaded
    
    BadPermissionsSimulationApplication
    
    Simulation application bundle could not be downloaded
    
    BadPermissionsS3Output
    
    Unable to publish outputs to customer-provided S3 bucket
    
    BadPermissionsCloudwatchLogs
    
    Unable to publish logs to customer-provided CloudWatch Logs resource
    
    SubnetIpLimitExceeded
    
    Subnet IP limit exceeded
    
    ENILimitExceeded
    
    ENI limit exceeded
    
    BadPermissionsUserCredentials
    
    Unable to use the Role provided
    
    InvalidBundleRobotApplication
    
    Robot bundle cannot be extracted (invalid format, bundling error, etc.)
    
    InvalidBundleSimulationApplication
    
    Simulation bundle cannot be extracted (invalid format, bundling error, etc.)
    
    RobotApplicationVersionMismatchedEtag
    
    Etag for RobotApplication does not match value during version creation
    
    SimulationApplicationVersionMismatchedEtag
    
    Etag for SimulationApplication does not match value during version creation
    
    See Also:
    
    SimulationJobErrorCode
  - failureCodeAsString
```
public String failureCodeAsString()
```
    The failure code of the simulation job if it failed:
    
    InternalServiceError
    
    Internal service error
    
    RobotApplicationCrash
    
    Robot application exited abnormally (segfault, etc.)
    
    SimulationApplicationCrash
    
    Simulation application exited abnormally (segfault, etc.)
    
    BadPermissionsRobotApplication
    
    Robot application bundle could not be downloaded
    
    BadPermissionsSimulationApplication
    
    Simulation application bundle could not be downloaded
    
    BadPermissionsS3Output
    
    Unable to publish outputs to customer-provided S3 bucket
    
    BadPermissionsCloudwatchLogs
    
    Unable to publish logs to customer-provided CloudWatch Logs resource
    
    SubnetIpLimitExceeded
    
    Subnet IP limit exceeded
    
    ENILimitExceeded
    
    ENI limit exceeded
    
    BadPermissionsUserCredentials
    
    Unable to use the Role provided
    
    InvalidBundleRobotApplication
    
    Robot bundle cannot be extracted (invalid format, bundling error, etc.)
    
    InvalidBundleSimulationApplication
    
    Simulation bundle cannot be extracted (invalid format, bundling error, etc.)
    
    RobotApplicationVersionMismatchedEtag
    
    Etag for RobotApplication does not match value during version creation
    
    SimulationApplicationVersionMismatchedEtag
    
    Etag for SimulationApplication does not match value during version creation
    
    If the service returns an enum value that is not available in the current SDK version, failureCode will return SimulationJobErrorCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().
    
    Returns:
    
    The failure code of the simulation job if it failed:
    
    InternalServiceError
    
    Internal service error
    
    RobotApplicationCrash
    
    Robot application exited abnormally (segfault, etc.)
    
    SimulationApplicationCrash
    
    Simulation application exited abnormally (segfault, etc.)
    
    BadPermissionsRobotApplication
    
    Robot application bundle could not be downloaded
    
    BadPermissionsSimulationApplication
    
    Simulation application bundle could not be downloaded
    
    BadPermissionsS3Output
    
    Unable to publish outputs to customer-provided S3 bucket
    
    BadPermissionsCloudwatchLogs
    
    Unable to publish logs to customer-provided CloudWatch Logs resource
    
    SubnetIpLimitExceeded
    
    Subnet IP limit exceeded
    
    ENILimitExceeded
    
    ENI limit exceeded
    
    BadPermissionsUserCredentials
    
    Unable to use the Role provided
    
    InvalidBundleRobotApplication
    
    Robot bundle cannot be extracted (invalid format, bundling error, etc.)
    
    InvalidBundleSimulationApplication
    
    Simulation bundle cannot be extracted (invalid format, bundling error, etc.)
    
    RobotApplicationVersionMismatchedEtag
    
    Etag for RobotApplication does not match value during version creation
    
    SimulationApplicationVersionMismatchedEtag
    
    Etag for SimulationApplication does not match value during version creation
    
    See Also:
    
    SimulationJobErrorCode
  - 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 job duration in seconds. The value must be 8 days (691,200 seconds) or less.
    
    Returns:
    
    The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
  - simulationTimeMillis
```
public Long simulationTimeMillis()
```
    The simulation job execution duration in milliseconds.
    
    Returns:
    
    The simulation job execution duration in milliseconds.
  - 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.
    
    Returns:
    
    The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
  - robotApplications
```
public List<RobotApplicationConfig> robotApplications()
```
    A list of robot applications.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of robot applications.
  - simulationApplications
```
public List<SimulationApplicationConfig> simulationApplications()
```
    A list of simulation applications.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of simulation applications.
  - vpcConfig
```
public VPCConfigResponse vpcConfig()
```
    The VPC configuration.
    
    Returns:
    
    The VPC configuration.
  - toBuilder
```
public DescribeSimulationJobResponse.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<DescribeSimulationJobResponse.Builder,DescribeSimulationJobResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static DescribeSimulationJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSimulationJobResponse.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: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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 DescribeSimulationJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.robomaker.model.RoboMakerResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

status

statusAsString

lastUpdatedAt

failureBehavior

failureBehaviorAsString

failureCode

failureCodeAsString

clientRequestToken

outputLocation

maxJobDurationInSeconds

simulationTimeMillis

iamRole

robotApplications

simulationApplications

vpcConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields