Class FlowExecutionSummary

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

Contains summary information about a flow execution, including its status, timestamps, and identifiers.

Flow executions is in preview release for Amazon Bedrock and is subject to change.

See Also:

  • Method Details

    • createdAt

      public final Instant createdAt()

      The timestamp when the flow execution was created.

      Returns:
      The timestamp when the flow execution was created.

    • endedAt

      public final Instant endedAt()

      The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

      Returns:
      The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.

    • executionArn

      public final String executionArn()

      The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the flow execution.

    • flowAliasIdentifier

      public final String flowAliasIdentifier()

      The unique identifier of the flow alias used for the execution.

      Returns:
      The unique identifier of the flow alias used for the execution.

    • flowIdentifier

      public final String flowIdentifier()

      The unique identifier of the flow.

      Returns:
      The unique identifier of the flow.

    • flowVersion

      public final String flowVersion()

      The version of the flow used for the execution.

      Returns:
      The version of the flow used for the execution.

    • status

      public final FlowExecutionStatus status()

      The current status of the flow execution.

      Flow executions time out after 24 hours.

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

      Returns:
      The current status of the flow execution.

      Flow executions time out after 24 hours.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the flow execution.

      Flow executions time out after 24 hours.

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

      Returns:
      The current status of the flow execution.

      Flow executions time out after 24 hours.

      See Also:

    • toBuilder

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

    • builder

      public static FlowExecutionSummary.Builder builder()

    • serializableBuilderClass

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