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("software.amazon.awssdk:codegen") public final class DescribeSimulationJobResponse extends RoboMakerResponse implements ToCopyableBuilder<DescribeSimulationJobResponse.Builder,DescribeSimulationJobResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeSimulationJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the simulation job.static DescribeSimulationJobResponse.Builderbuilder()StringclientRequestToken()Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.ComputeResponsecompute()Compute information for the simulation job.List<DataSource>dataSources()The data sources for the simulation job.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FailureBehaviorfailureBehavior()The failure behavior for the simulation job.StringfailureBehaviorAsString()The failure behavior for the simulation job.SimulationJobErrorCodefailureCode()The failure code of the simulation job if it failed:StringfailureCodeAsString()The failure code of the simulation job if it failed:StringfailureReason()Details about why the simulation job failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataSources()For responses, this returns true if the service returned a value for the DataSources property.inthashCode()booleanhasRobotApplications()For responses, this returns true if the service returned a value for the RobotApplications property.booleanhasSimulationApplications()For responses, this returns true if the service returned a value for the SimulationApplications property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringiamRole()The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.InstantlastStartedAt()The time, in milliseconds since the epoch, when the simulation job was last started.InstantlastUpdatedAt()The time, in milliseconds since the epoch, when the simulation job was last updated.LoggingConfigloggingConfig()The logging configuration.LongmaxJobDurationInSeconds()The maximum job duration in seconds.Stringname()The name of the simulation job.NetworkInterfacenetworkInterface()The network interface information for the simulation job.OutputLocationoutputLocation()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.LongsimulationTimeMillis()The simulation job execution duration in milliseconds.SimulationJobStatusstatus()The status of the simulation job.StringstatusAsString()The status of the simulation job.Map<String,String>tags()The list of all tags added to the specified simulation job.DescribeSimulationJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.VPCConfigResponsevpcConfig()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
clone, finalize, 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,
statuswill returnSimulationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnSimulationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
failureBehaviorwill 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:
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,
failureBehaviorwill 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:
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,
failureCodewill 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:
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,
failureCodewill 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:
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()
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
public final List<RobotApplicationConfig> 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
public final List<SimulationApplicationConfig> 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
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.
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
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.
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
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeSimulationJobResponse.Builder,DescribeSimulationJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeSimulationJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeSimulationJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-