Class NodeInputField
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagentruntime.model.NodeInputField
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<NodeInputField.Builder,NodeInputField>
@Generated("software.amazon.awssdk:codegen") public final class NodeInputField extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NodeInputField.Builder,NodeInputField>
Represents an input field provided to a node during a flow execution.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceNodeInputField.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static NodeInputField.Builderbuilder()FlowNodeInputCategorycategory()The category of the input field.StringcategoryAsString()The category of the input field.NodeExecutionContentcontent()The content of the input field, which can contain text or structured data.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<NodeInputExecutionChainItem>executionChain()The execution path through nested nodes like iterators and loops.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExecutionChain()For responses, this returns true if the service returned a value for the ExecutionChain property.inthashCode()Stringname()The name of the input field as defined in the node's input schema.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends NodeInputField.Builder>serializableBuilderClass()NodeInputSourcesource()The source node that provides input data to this field.NodeInputField.BuildertoBuilder()StringtoString()Returns a string representation of this object.FlowNodeIODataTypetype()The data type of the input field for compatibility validation.StringtypeAsString()The data type of the input field for compatibility validation.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the input field as defined in the node's input schema.
- Returns:
- The name of the input field as defined in the node's input schema.
-
content
public final NodeExecutionContent content()
The content of the input field, which can contain text or structured data.
- Returns:
- The content of the input field, which can contain text or structured data.
-
source
public final NodeInputSource source()
The source node that provides input data to this field.
- Returns:
- The source node that provides input data to this field.
-
type
public final FlowNodeIODataType type()
The data type of the input field for compatibility validation.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFlowNodeIODataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The data type of the input field for compatibility validation.
- See Also:
FlowNodeIODataType
-
typeAsString
public final String typeAsString()
The data type of the input field for compatibility validation.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFlowNodeIODataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The data type of the input field for compatibility validation.
- See Also:
FlowNodeIODataType
-
category
public final FlowNodeInputCategory category()
The category of the input field.
If the service returns an enum value that is not available in the current SDK version,
categorywill returnFlowNodeInputCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of the input field.
- See Also:
FlowNodeInputCategory
-
categoryAsString
public final String categoryAsString()
The category of the input field.
If the service returns an enum value that is not available in the current SDK version,
categorywill returnFlowNodeInputCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of the input field.
- See Also:
FlowNodeInputCategory
-
hasExecutionChain
public final boolean hasExecutionChain()
For responses, this returns true if the service returned a value for the ExecutionChain property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
executionChain
public final List<NodeInputExecutionChainItem> executionChain()
The execution path through nested nodes like iterators and loops.
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
hasExecutionChain()method.- Returns:
- The execution path through nested nodes like iterators and loops.
-
toBuilder
public NodeInputField.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<NodeInputField.Builder,NodeInputField>
-
builder
public static NodeInputField.Builder builder()
-
serializableBuilderClass
public static Class<? extends NodeInputField.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-