Package software.amazon.awssdk.services.bedrockagentruntime.model

Class StartFlowExecutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest
software.amazon.awssdk.services.bedrockagentruntime.model.StartFlowExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartFlowExecutionRequest.Builder,StartFlowExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartFlowExecutionRequest extends BedrockAgentRuntimeRequest implements ToCopyableBuilder<StartFlowExecutionRequest.Builder,StartFlowExecutionRequest>

  • Method Details

    • flowAliasIdentifier

      public final String flowAliasIdentifier()

      The unique identifier of the flow alias to use for the flow execution.

      Returns:
      The unique identifier of the flow alias to use for the flow execution.

    • flowExecutionName

      public final String flowExecutionName()

      The unique name for the flow execution. If you don't provide one, a system-generated name is used.

      Returns:
      The unique name for the flow execution. If you don't provide one, a system-generated name is used.

    • flowIdentifier

      public final String flowIdentifier()

      The unique identifier of the flow to execute.

      Returns:
      The unique identifier of the flow to execute.

    • hasInputs

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

    • inputs

      public final List<FlowInput> inputs()

      The input data required for the flow execution. This must match the input schema defined in the flow.

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

      Returns:
      The input data required for the flow execution. This must match the input schema defined in the flow.

    • modelPerformanceConfiguration

      public final ModelPerformanceConfiguration modelPerformanceConfiguration()

      The performance settings for the foundation model used in the flow execution.

      Returns:
      The performance settings for the foundation model used in the flow execution.

    • toBuilder

      public StartFlowExecutionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartFlowExecutionRequest.Builder,StartFlowExecutionRequest>
      Specified by:
      toBuilder in class BedrockAgentRuntimeRequest

    • builder

      public static StartFlowExecutionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartFlowExecutionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo