Class FlowFailureEvent

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

Contains information about a failure that occurred at the flow level during a flow execution.

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

See Also:

  • Method Details

    • errorCode

      public final FlowErrorCode errorCode()

      The error code that identifies the type of failure that occurred.

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

      Returns:
      The error code that identifies the type of failure that occurred.
      See Also:

    • errorCodeAsString

      public final String errorCodeAsString()

      The error code that identifies the type of failure that occurred.

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

      Returns:
      The error code that identifies the type of failure that occurred.
      See Also:

    • errorMessage

      public final String errorMessage()

      A descriptive message that provides details about the failure.

      Returns:
      A descriptive message that provides details about the failure.

    • timestamp

      public final Instant timestamp()

      The timestamp when the failure occurred.

      Returns:
      The timestamp when the failure occurred.

    • toBuilder

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

    • builder

      public static FlowFailureEvent.Builder builder()

    • serializableBuilderClass

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