Class FlowNodeInput

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

Contains configurations for an input in an Amazon Bedrock Flows node.

See Also:

  • Method Details

    • category

      public final FlowNodeInputCategory category()

      Specifies how input data flows between iterations in a DoWhile loop.

      • LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.

      • ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.

      • ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.

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

      Returns:
      Specifies how input data flows between iterations in a DoWhile loop.

      • LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.

      • ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.

      • ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.

      See Also:

    • categoryAsString

      public final String categoryAsString()

      Specifies how input data flows between iterations in a DoWhile loop.

      • LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.

      • ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.

      • ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.

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

      Returns:
      Specifies how input data flows between iterations in a DoWhile loop.

      • LoopCondition - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.

      • ReturnValueToLoopStart - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.

      • ExitLoop - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.

      See Also:

    • expression

      public final String expression()

      An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

      Returns:
      An expression that formats the input for the node. For an explanation of how to create expressions, see Expressions in Prompt flows in Amazon Bedrock.

    • name

      public final String name()

      Specifies a name for the input that you can reference.

      Returns:
      Specifies a name for the input that you can reference.

    • type

      public final FlowNodeIODataType type()

      Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

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

      Returns:
      Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.

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

      Returns:
      Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
      See Also:

    • toBuilder

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

    • builder

      public static FlowNodeInput.Builder builder()

    • serializableBuilderClass

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