@Generated(value="software.amazon.awssdk:codegen") public final class CreateFlowRequest extends AppflowRequest implements ToCopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateFlowRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateFlowRequest.Builder |
builder() |
String |
clientToken()
The
clientToken parameter is an idempotency token. |
String |
description()
A description of the flow you want to create.
|
List<DestinationFlowConfig> |
destinationFlowConfigList()
The configuration that controls how Amazon AppFlow places data in the destination connector.
|
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) |
boolean |
hasDestinationFlowConfigList()
For responses, this returns true if the service returned a value for the DestinationFlowConfigList property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasTasks()
For responses, this returns true if the service returned a value for the Tasks property.
|
String |
kmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
|
MetadataCatalogConfig |
metadataCatalogConfig()
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the
associated flow.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateFlowRequest.Builder> |
serializableBuilderClass() |
SourceFlowConfig |
sourceFlowConfig()
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
|
Map<String,String> |
tags()
The tags used to organize, track, or control access for your flow.
|
List<Task> |
tasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
|
CreateFlowRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
TriggerConfig |
triggerConfig()
The trigger settings that determine how and when the flow runs.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String flowName()
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
public final String description()
A description of the flow you want to create.
public final String kmsArn()
The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
public final TriggerConfig triggerConfig()
The trigger settings that determine how and when the flow runs.
public final SourceFlowConfig sourceFlowConfig()
The configuration that controls how Amazon AppFlow retrieves data from the source connector.
public final boolean hasDestinationFlowConfigList()
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.public final List<DestinationFlowConfig> destinationFlowConfigList()
The configuration that controls how Amazon AppFlow places data in the destination connector.
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 hasDestinationFlowConfigList() method.
public final boolean hasTasks()
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.public final List<Task> tasks()
A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
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 hasTasks() method.
public final boolean hasTags()
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.public final Map<String,String> tags()
The tags used to organize, track, or control access for your 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 hasTags() method.
public final MetadataCatalogConfig metadataCatalogConfig()
Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.
public final String clientToken()
The clientToken parameter is an idempotency token. It ensures that your CreateFlow
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. If you use a different
value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token
is active for 8 hours.
clientToken parameter is an idempotency token. It ensures that your
CreateFlow 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. If you use a
different value for clientToken, Amazon AppFlow considers it a new call to
CreateFlow. The token is active for 8 hours.
public CreateFlowRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateFlowRequest.Builder,CreateFlowRequest>toBuilder in class AppflowRequestpublic static CreateFlowRequest.Builder builder()
public static Class<? extends CreateFlowRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.