Class GetFlowExecutionResponse

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

  • Method Details

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

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

    • startedAt

      public final Instant startedAt()

      The timestamp when the flow execution started.

      Returns:
      The timestamp when the flow execution started.

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

    • hasErrors

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

    • errors

      public final List<FlowExecutionError> errors()

      A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

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

      Returns:
      A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.

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

    • toBuilder

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

    • builder

      public static GetFlowExecutionResponse.Builder builder()

    • serializableBuilderClass

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