Package software.amazon.awssdk.services.robomaker.model

Class StartSimulationJobBatchResponse

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (arn) of the batch.

        Returns:
        The Amazon Resource Name (arn) of the batch.

      • status

        public final SimulationJobBatchStatus status()

        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        If the service returns an enum value that is not available in the current SDK version, status will return SimulationJobBatchStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        See Also:
        SimulationJobBatchStatus

      • statusAsString

        public final String statusAsString()

        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        If the service returns an enum value that is not available in the current SDK version, status will return SimulationJobBatchStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the simulation job batch.

        Pending

        The simulation job batch request is pending.

        InProgress

        The simulation job batch is in progress.

        Failed

        The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

        Completed

        The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

        Canceled

        The simulation batch job was cancelled.

        Canceling

        The simulation batch job is being cancelled.

        Completing

        The simulation batch job is completing.

        TimingOut

        The simulation job batch is timing out.

        If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

        TimedOut

        The simulation batch job timed out.

        See Also:
        SimulationJobBatchStatus

      • createdAt

        public final Instant createdAt()

        The time, in milliseconds since the epoch, when the simulation job batch was created.

        Returns:
        The time, in milliseconds since the epoch, when the simulation job batch was created.

      • 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.

      • batchPolicy

        public final BatchPolicy batchPolicy()

        The batch policy.

        Returns:
        The batch policy.

      • failureReason

        public final String failureReason()

        The reason the simulation job batch failed.

        Returns:
        The reason the simulation job batch failed.

      • hasFailedRequests

        public final boolean hasFailedRequests()
        For responses, this returns true if the service returned a value for the FailedRequests property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • failedRequests

        public final List<FailedCreateSimulationJobRequest> failedRequests()

        A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

        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 hasFailedRequests() method.

        Returns:
        A list of failed simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.

      • hasPendingRequests

        public final boolean hasPendingRequests()
        For responses, this returns true if the service returned a value for the PendingRequests property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • pendingRequests

        public final List<SimulationJobRequest> pendingRequests()

        A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

        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 hasPendingRequests() method.

        Returns:
        A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

      • hasCreatedRequests

        public final boolean hasCreatedRequests()
        For responses, this returns true if the service returned a value for the CreatedRequests property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • createdRequests

        public final List<SimulationJobSummary> createdRequests()

        A list of created simulation job request summaries.

        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 hasCreatedRequests() method.

        Returns:
        A list of created simulation job request summaries.

      • 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 the isEmpty() 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()

        A map that contains tag keys and tag values that are attached to the deployment job batch.

        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:
        A map that contains tag keys and tag values that are attached to the deployment job batch.

      • 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