Class FlowSummary

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

Contains the definition of a flow.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the flow.

      Returns:
      The Amazon Resource Name (ARN) of the flow.

    • createdAt

      public final Instant createdAt()

      The time at which the flow was created.

      Returns:
      The time at which the flow was created.

    • description

      public final String description()

      A description of the flow.

      Returns:
      A description of the flow.

    • id

      public final String id()

      The unique identifier of the flow.

      Returns:
      The unique identifier of the flow.

    • name

      public final String name()

      The name of the flow.

      Returns:
      The name of the flow.

    • status

      public final FlowStatus status()

      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

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

      Returns:
      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

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

      Returns:
      The status of the flow. The following statuses are possible:

      • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

      • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

      • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

      • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

      See Also:

    • updatedAt

      public final Instant updatedAt()

      The time at which the flow was last updated.

      Returns:
      The time at which the flow was last updated.

    • version

      public final String version()

      The latest version of the flow.

      Returns:
      The latest version of the flow.

    • toBuilder

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

    • builder

      public static FlowSummary.Builder builder()

    • serializableBuilderClass

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