Package software.amazon.awssdk.services.appflow.model

Class StartFlowRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appflow.model.AppflowRequest

software.amazon.awssdk.services.appflow.model.StartFlowRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartFlowRequest.Builder,StartFlowRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartFlowRequest
extends AppflowRequest
implements ToCopyableBuilder<StartFlowRequest.Builder,StartFlowRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartFlowRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartFlowRequest.Builder	builder()
String	clientToken()	The clientToken parameter is an idempotency token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flowName()	The specified name of the flow.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StartFlowRequest.Builder>	serializableBuilderClass()
StartFlowRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

flowName

public final String flowName()

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

Returns:

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

clientToken

public final 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.

Returns:

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.

toBuilder

public StartFlowRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartFlowRequest.Builder,StartFlowRequest>

Specified by:

toBuilder in class AppflowRequest

builder

public static StartFlowRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartFlowRequest.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