software.amazon.awssdk.services.robomaker.model

Class DescribeSimulationJobResponse

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

Method Summary

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.
ComputeResponse	compute() Compute information for the simulation job.
List<DataSource>	dataSources() The data sources for the simulation job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
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:
String	failureReason() Details about why the simulation job failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
boolean	hasDataSources() Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasRobotApplications() Returns true if the RobotApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSimulationApplications() Returns true if the SimulationApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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	lastStartedAt() The time, in milliseconds since the epoch, when the simulation job was last started.
Instant	lastUpdatedAt() The time, in milliseconds since the epoch, when the simulation job was last updated.
LoggingConfig	loggingConfig() The logging configuration.
Long	maxJobDurationInSeconds() The maximum job duration in seconds.
String	name() The name of the simulation job.
NetworkInterface	networkInterface() The network interface information for 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.
Map<String,String>	tags() The list of all tags added to the specified 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() Returns a string representation of this object.
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 final String arn()

The Amazon Resource Name (ARN) of the simulation job.

Returns:

The Amazon Resource Name (ARN) of the simulation job.

name

public final String name()

The name of the simulation job.

Returns:

The name of the simulation job.

status

public final 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 final 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

lastStartedAt

public final Instant lastStartedAt()

The time, in milliseconds since the epoch, when the simulation job was last started.

Returns:

The time, in milliseconds since the epoch, when the simulation job was last started.

lastUpdatedAt

public final 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 final 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 final 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 final SimulationJobErrorCode failureCode()

The failure code of the simulation job if it failed:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

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, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

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.

SimulationApplicationCrash

Simulation application exited abnormally.

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, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

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 final String failureCodeAsString()

The failure code of the simulation job if it failed:

InternalServiceError

Internal service error.

RobotApplicationCrash

Robot application exited abnormally.

SimulationApplicationCrash

Simulation application exited abnormally.

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, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

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.

SimulationApplicationCrash

Simulation application exited abnormally.

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, or other issue).

InvalidBundleSimulationApplication

Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

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

failureReason

public final String failureReason()

Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

Returns:

Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

clientRequestToken

public final 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 final OutputLocation outputLocation()

Location for output files generated by the simulation job.

Returns:

Location for output files generated by the simulation job.

loggingConfig

public final LoggingConfig loggingConfig()

The logging configuration.

Returns:

The logging configuration.

maxJobDurationInSeconds

public final 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 final Long simulationTimeMillis()

The simulation job execution duration in milliseconds.

Returns:

The simulation job execution duration in milliseconds.

iamRole

public final 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.

hasRobotApplications

public final boolean hasRobotApplications()

Returns true if the RobotApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

robotApplications

public final List<RobotApplicationConfig> robotApplications()

A list of robot applications.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRobotApplications() to see if a value was sent in this field.

Returns:

A list of robot applications.

hasSimulationApplications

public final boolean hasSimulationApplications()

Returns true if the SimulationApplications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

simulationApplications

public final List<SimulationApplicationConfig> simulationApplications()

A list of simulation applications.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSimulationApplications() to see if a value was sent in this field.

Returns:

A list of simulation applications.

hasDataSources

public final boolean hasDataSources()

Returns true if the DataSources property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

dataSources

public final List<DataSource> dataSources()

The data sources for the simulation job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDataSources() to see if a value was sent in this field.

Returns:

The data sources for the simulation job.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The list of all tags added to the specified simulation job.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The list of all tags added to the specified simulation job.

vpcConfig

public final VPCConfigResponse vpcConfig()

The VPC configuration.

Returns:

The VPC configuration.

networkInterface

public final NetworkInterface networkInterface()

The network interface information for the simulation job.

Returns:

The network interface information for the simulation job.

compute

public final ComputeResponse compute()

Compute information for the simulation job.

Returns:

Compute information for the simulation job.

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 final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <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 final 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.