Interface CancelFlowExecutionsRequest.Builder

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

  • Method Details

    • flowName

      CancelFlowExecutionsRequest.Builder flowName(String flowName)

      The name of a flow with active runs that you want to cancel.

      Parameters:
      flowName - The name of a flow with active runs that you want to cancel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionIds

      CancelFlowExecutionsRequest.Builder executionIds(Collection<String> executionIds)

      The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

      If you omit this parameter, your request ends all active runs that belong to the flow.

      Parameters:
      executionIds - The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

      If you omit this parameter, your request ends all active runs that belong to the flow.

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

    • executionIds

      CancelFlowExecutionsRequest.Builder executionIds(String... executionIds)

      The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

      If you omit this parameter, your request ends all active runs that belong to the flow.

      Parameters:
      executionIds - The ID of each active run to cancel. These runs must belong to the flow you specify in your request.

      If you omit this parameter, your request ends all active runs that belong to the flow.

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

    • overrideConfiguration

      CancelFlowExecutionsRequest.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

      CancelFlowExecutionsRequest.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.