Class GetWorkflowRunResponse

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

  • Method Details

    • spaceName

      public final String spaceName()

      The name of the space.

      Returns:
      The name of the space.

    • projectName

      public final String projectName()

      The name of the project in the space.

      Returns:
      The name of the project in the space.

    • id

      public final String id()

      The ID of the workflow run.

      Returns:
      The ID of the workflow run.

    • workflowId

      public final String workflowId()

      The ID of the workflow.

      Returns:
      The ID of the workflow.

    • status

      public final WorkflowRunStatus status()

      The status of the workflow run.

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

      Returns:
      The status of the workflow run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the workflow run.

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

      Returns:
      The status of the workflow run.
      See Also:

    • hasStatusReasons

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

    • statusReasons

      public final List<WorkflowRunStatusReason> statusReasons()

      Information about the reasons for the status of the workflow run.

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

      Returns:
      Information about the reasons for the status of the workflow run.

    • startTime

      public final Instant startTime()

      The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      Returns:
      The date and time the workflow run began, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

    • endTime

      public final Instant endTime()

      The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

      Returns:
      The date and time the workflow run ended, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

      Returns:
      The date and time the workflow run status was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

    • toBuilder

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

    • builder

      public static GetWorkflowRunResponse.Builder builder()

    • serializableBuilderClass

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