Class GetTaskInstanceResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mwaaserverless.model.MwaaServerlessResponse
software.amazon.awssdk.services.mwaaserverless.model.GetTaskInstanceResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetTaskInstanceResponse.Builder,GetTaskInstanceResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetTaskInstanceResponse extends MwaaServerlessResponse implements ToCopyableBuilder<GetTaskInstanceResponse.Builder,GetTaskInstanceResponse>

  • Method Details

    • workflowArn

      public final String workflowArn()

      The Amazon Resource Name (ARN) of the workflow that contains this task instance.

      Returns:
      The Amazon Resource Name (ARN) of the workflow that contains this task instance.

    • runId

      public final String runId()

      The unique identifier of the workflow run that contains this task instance.

      Returns:
      The unique identifier of the workflow run that contains this task instance.

    • taskInstanceId

      public final String taskInstanceId()

      The unique identifier of this task instance.

      Returns:
      The unique identifier of this task instance.

    • workflowVersion

      public final String workflowVersion()

      The version of the workflow that contains this task instance.

      Returns:
      The version of the workflow that contains this task instance.

    • status

      public final TaskInstanceStatus status()

      The current status of the task instance.

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

      Returns:
      The current status of the task instance.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the task instance.

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

      Returns:
      The current status of the task instance.
      See Also:

    • durationInSeconds

      public final Integer durationInSeconds()

      The duration of the task instance execution in seconds. This value is null if the task is not complete.

      Returns:
      The duration of the task instance execution in seconds. This value is null if the task is not complete.

    • operatorName

      public final String operatorName()

      The name of the Apache Airflow operator used for this task instance.

      Returns:
      The name of the Apache Airflow operator used for this task instance.

    • modifiedAt

      public final Instant modifiedAt()

      The timestamp when the task instance was last modified, in ISO 8601 date-time format.

      Returns:
      The timestamp when the task instance was last modified, in ISO 8601 date-time format.

    • endedAt

      public final Instant endedAt()

      The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.

      Returns:
      The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.

    • startedAt

      public final Instant startedAt()

      The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.

      Returns:
      The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.

    • attemptNumber

      public final Integer attemptNumber()

      The attempt number for this task instance.

      Returns:
      The attempt number for this task instance.

    • errorMessage

      public final String errorMessage()

      The error message if the task instance failed. This value is null if the task completed successfully.

      Returns:
      The error message if the task instance failed. This value is null if the task completed successfully.

    • taskId

      public final String taskId()

      The unique identifier of the task definition within the workflow.

      Returns:
      The unique identifier of the task definition within the workflow.

    • logStream

      public final String logStream()

      The CloudWatch log stream name for this task instance execution.

      Returns:
      The CloudWatch log stream name for this task instance execution.

    • hasXcom

      public final boolean hasXcom()
      For responses, this returns true if the service returned a value for the Xcom 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.

    • xcom

      public final Map<String,String> xcom()

      Cross-communication data exchanged between tasks in the workflow execution.

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

      Returns:
      Cross-communication data exchanged between tasks in the workflow execution.

    • toBuilder

      public GetTaskInstanceResponse.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<GetTaskInstanceResponse.Builder,GetTaskInstanceResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetTaskInstanceResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetTaskInstanceResponse.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.