Interface StartFlowRequest.Builder
- All Superinterfaces:
AppflowRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<StartFlowRequest.Builder,
,StartFlowRequest> SdkBuilder<StartFlowRequest.Builder,
,StartFlowRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartFlowRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) TheclientToken
parameter is an idempotency token.The specified name of the flow.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.services.appflow.model.AppflowRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The
clientToken
parameter is an idempotency token. It ensures that yourStartFlow
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 sameclientToken
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 toStartFlow
. The token is active for 8 hours.- Parameters:
clientToken
- TheclientToken
parameter is an idempotency token. It ensures that yourStartFlow
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 sameclientToken
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 toStartFlow
. 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-