Class DescribeSimulationJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeSimulationJobResponse.Builder,
DescribeSimulationJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the simulation job.builder()
final String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final ComputeResponse
compute()
Compute information for the simulation job.final List
<DataSource> The data sources for the simulation job.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 for the simulation job.final String
The failure behavior for the simulation job.final SimulationJobErrorCode
The failure code of the simulation job if it failed:final String
The failure code of the simulation job if it failed:final String
Details about why the simulation job failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.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 that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.final Instant
The time, in milliseconds since the epoch, when the simulation job was last started.final Instant
The time, in milliseconds since the epoch, when the simulation job was last updated.final LoggingConfig
The logging configuration.final Long
The maximum job duration in seconds.final String
name()
The name of the simulation job.final NetworkInterface
The network interface information for the simulation job.final OutputLocation
Location for output files generated by the simulation job.final List
<RobotApplicationConfig> A list of robot applications.static Class
<? extends DescribeSimulationJobResponse.Builder> final List
<SimulationApplicationConfig> A list of simulation applications.final Long
The simulation job execution duration in milliseconds.final SimulationJobStatus
status()
The status of the simulation job.final String
The status of the simulation job.tags()
The list of all tags added to the specified simulation job.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 VPCConfigResponse
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the simulation job.
- Returns:
- The Amazon Resource Name (ARN) of the simulation job.
-
name
The name of the simulation job.
- Returns:
- The name of the simulation job.
-
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 returnSimulationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the simulation job.
- See Also:
-
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 returnSimulationJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the simulation job.
- See Also:
-
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
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
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 returnFailureBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureBehaviorAsString()
.- Returns:
- The failure behavior for the simulation job.
- See Also:
-
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 returnFailureBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureBehaviorAsString()
.- Returns:
- The failure behavior for the simulation job.
- See Also:
-
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 returnSimulationJobErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- 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:
-
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 returnSimulationJobErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfailureCodeAsString()
.- 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:
-
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
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
Location for output files generated by the simulation job.
- Returns:
- Location for output files generated by the simulation job.
-
loggingConfig
The logging configuration.
- Returns:
- The logging configuration.
-
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
The simulation job execution duration in milliseconds.
- Returns:
- The simulation job execution duration in milliseconds.
-
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()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
A list of robot applications.
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:
- A list of robot applications.
-
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
A list of simulation applications.
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:
- A list of simulation applications.
-
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
The data sources for 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
hasDataSources()
method.- Returns:
- The data sources 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
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.
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:
- The list of all tags added to the specified simulation job.
-
vpcConfig
The VPC configuration.
- Returns:
- The VPC configuration.
-
networkInterface
The network interface information for the simulation job.
- Returns:
- The network interface information for the simulation job.
-
compute
Compute information for the simulation job.
- Returns:
- Compute information for the simulation job.
-
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<DescribeSimulationJobResponse.Builder,
DescribeSimulationJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-