Class WorkflowSummary

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

Information about a workflow.

See Also:

  • Method Details

    • id

      public final String id()

      The system-generated unique ID of a workflow.

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

    • name

      public final String name()

      The name of the workflow.

      Returns:
      The name of the workflow.

    • sourceRepositoryName

      public final String sourceRepositoryName()

      The name of the source repository where the workflow definition file is stored.

      Returns:
      The name of the source repository where the workflow definition file is stored.

    • sourceBranchName

      public final String sourceBranchName()

      The name of the branch of the source repository where the workflow definition file is stored.

      Returns:
      The name of the branch of the source repository where the workflow definition file is stored.

    • definition

      public final WorkflowDefinitionSummary definition()

      Information about the workflow definition file.

      Returns:
      Information about the workflow definition file.

    • createdTime

      public final Instant createdTime()

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

      Returns:
      The date and time the workflow was created, 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

    • runMode

      public final WorkflowRunMode runMode()

      The run mode of the workflow.

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

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

    • runModeAsString

      public final String runModeAsString()

      The run mode of the workflow.

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

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

    • status

      public final WorkflowStatus status()

      The status of the workflow.

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

      Returns:
      The status of the workflow.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the workflow.

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

      Returns:
      The status of the workflow.
      See Also:

    • toBuilder

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

    • builder

      public static WorkflowSummary.Builder builder()

    • serializableBuilderClass

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