Class NodeOutputField

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

Represents an output field produced by a node during a flow execution.

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

See Also:

  • Method Details

    • name

      public final String name()

      The name of the output field as defined in the node's output schema.

      Returns:
      The name of the output field as defined in the node's output schema.

    • content

      public final NodeExecutionContent content()

      The content of the output field, which can contain text or structured data.

      Returns:
      The content of the output field, which can contain text or structured data.

    • hasNext

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

    • next

      public final List<NodeOutputNext> next()

      The next node that receives output data from this field.

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

      Returns:
      The next node that receives output data from this field.

    • type

      public final FlowNodeIODataType type()

      The data type of the output field for compatibility validation.

      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:
      The data type of the output field for compatibility validation.
      See Also:

    • typeAsString

      public final String typeAsString()

      The data type of the output field for compatibility validation.

      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:
      The data type of the output field for compatibility validation.
      See Also:

    • toBuilder

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

    • builder

      public static NodeOutputField.Builder builder()

    • serializableBuilderClass

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