Class WorkflowRunSummary

java.lang.Object
software.amazon.awssdk.services.codecatalyst.model.WorkflowRunSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkflowRunSummary.Builder,WorkflowRunSummary>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowRunSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowRunSummary.Builder,WorkflowRunSummary>

Information about a workflow run.

See Also:

  • Method Details

    • id

      public final String id()

      The system-generated unique ID of the workflow run.

      Returns:
      The system-generated unique ID of the workflow run.

    • workflowId

      public final String workflowId()

      The system-generated unique ID of the workflow.

      Returns:
      The system-generated unique ID of the workflow.

    • workflowName

      public final String workflowName()

      The name of the workflow.

      Returns:
      The name 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()

      The reasons for the workflow run status.

      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:
      The reasons for the workflow run status.

    • 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 was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339

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

    • toBuilder

      public WorkflowRunSummary.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<WorkflowRunSummary.Builder,WorkflowRunSummary>
      Returns:
      a builder for type T

    • builder

      public static WorkflowRunSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkflowRunSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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