Interface StartFlowRequest.Builder

All Superinterfaces:
AppflowRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartFlowRequest.Builder,StartFlowRequest>, SdkBuilder<StartFlowRequest.Builder,StartFlowRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartFlowRequest
public static interface StartFlowRequest.Builder extends AppflowRequest.Builder, SdkPojo, CopyableBuilder<StartFlowRequest.Builder,StartFlowRequest>

  • Method Details

    • flowName

      StartFlowRequest.Builder flowName(String flowName)

      The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

      Parameters:
      flowName - The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartFlowRequest.Builder clientToken(String clientToken)

      The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

      If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

      Parameters:
      clientToken - The clientToken parameter is an idempotency token. It ensures that your StartFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

      If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

      If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the triggerConfig parameter.

      If you use a different value for clientToken, Amazon AppFlow considers it a new call to StartFlow. The token is active for 8 hours.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartFlowRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartFlowRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.