com.amazonaws.services.appflow.model

Class CreateFlowRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appflow.model.CreateFlowRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFlowRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFlowRequest()

Method Summary

Modifier and Type	Method and Description
CreateFlowRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateFlowRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateFlowRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() The clientToken parameter is an idempotency token.
String	getDescription() A description of the flow you want to create.
List<DestinationFlowConfig>	getDestinationFlowConfigList() The configuration that controls how Amazon AppFlow places data in the destination connector.
String	getFlowName() The specified name of the flow.
String	getKmsArn() The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
MetadataCatalogConfig	getMetadataCatalogConfig() Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.
SourceFlowConfig	getSourceFlowConfig() The configuration that controls how Amazon AppFlow retrieves data from the source connector.
Map<String,String>	getTags() The tags used to organize, track, or control access for your flow.
List<Task>	getTasks() A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
TriggerConfig	getTriggerConfig() The trigger settings that determine how and when the flow runs.
int	hashCode()
void	setClientToken(String clientToken) The clientToken parameter is an idempotency token.
void	setDescription(String description) A description of the flow you want to create.
void	setDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
void	setFlowName(String flowName) The specified name of the flow.
void	setKmsArn(String kmsArn) The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
void	setMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig) Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.
void	setSourceFlowConfig(SourceFlowConfig sourceFlowConfig) The configuration that controls how Amazon AppFlow retrieves data from the source connector.
void	setTags(Map<String,String> tags) The tags used to organize, track, or control access for your flow.
void	setTasks(Collection<Task> tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
void	setTriggerConfig(TriggerConfig triggerConfig) The trigger settings that determine how and when the flow runs.
String	toString() Returns a string representation of this object.
CreateFlowRequest	withClientToken(String clientToken) The clientToken parameter is an idempotency token.
CreateFlowRequest	withDescription(String description) A description of the flow you want to create.
CreateFlowRequest	withDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
CreateFlowRequest	withDestinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList) The configuration that controls how Amazon AppFlow places data in the destination connector.
CreateFlowRequest	withFlowName(String flowName) The specified name of the flow.
CreateFlowRequest	withKmsArn(String kmsArn) The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption.
CreateFlowRequest	withMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig) Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow.
CreateFlowRequest	withSourceFlowConfig(SourceFlowConfig sourceFlowConfig) The configuration that controls how Amazon AppFlow retrieves data from the source connector.
CreateFlowRequest	withTags(Map<String,String> tags) The tags used to organize, track, or control access for your flow.
CreateFlowRequest	withTasks(Collection<Task> tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
CreateFlowRequest	withTasks(Task... tasks) A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
CreateFlowRequest	withTriggerConfig(TriggerConfig triggerConfig) The trigger settings that determine how and when the flow runs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFlowRequest

public CreateFlowRequest()

Method Detail

setFlowName

public void setFlowName(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.

getFlowName

public String getFlowName()

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.

withFlowName

public CreateFlowRequest withFlowName(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.

setDescription

public void setDescription(String description)

A description of the flow you want to create.

Parameters:

description - A description of the flow you want to create.

getDescription

public String getDescription()

A description of the flow you want to create.

Returns:

A description of the flow you want to create.

withDescription

public CreateFlowRequest withDescription(String description)

A description of the flow you want to create.

Parameters:

description - A description of the flow you want to create.

Returns:

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

setKmsArn

public void setKmsArn(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.

Parameters:

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.

getKmsArn

public String getKmsArn()

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.

Returns:

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.

withKmsArn

public CreateFlowRequest withKmsArn(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.

Parameters:

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.

Returns:

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

setTriggerConfig

public void setTriggerConfig(TriggerConfig triggerConfig)

The trigger settings that determine how and when the flow runs.

Parameters:

triggerConfig - The trigger settings that determine how and when the flow runs.

getTriggerConfig

public TriggerConfig getTriggerConfig()

The trigger settings that determine how and when the flow runs.

Returns:

The trigger settings that determine how and when the flow runs.

withTriggerConfig

public CreateFlowRequest withTriggerConfig(TriggerConfig triggerConfig)

The trigger settings that determine how and when the flow runs.

Parameters:

triggerConfig - The trigger settings that determine how and when the flow runs.

Returns:

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

setSourceFlowConfig

public void setSourceFlowConfig(SourceFlowConfig sourceFlowConfig)

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Parameters:

sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.

getSourceFlowConfig

public SourceFlowConfig getSourceFlowConfig()

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Returns:

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

withSourceFlowConfig

public CreateFlowRequest withSourceFlowConfig(SourceFlowConfig sourceFlowConfig)

The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Parameters:

sourceFlowConfig - The configuration that controls how Amazon AppFlow retrieves data from the source connector.

Returns:

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

getDestinationFlowConfigList

public List<DestinationFlowConfig> getDestinationFlowConfigList()

The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:

The configuration that controls how Amazon AppFlow places data in the destination connector.

setDestinationFlowConfigList

public void setDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

Parameters:

destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

withDestinationFlowConfigList

public CreateFlowRequest withDestinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

NOTE: This method appends the values to the existing list (if any). Use setDestinationFlowConfigList(java.util.Collection) or withDestinationFlowConfigList(java.util.Collection) if you want to override the existing values.

Parameters:

destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:

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

withDestinationFlowConfigList

public CreateFlowRequest withDestinationFlowConfigList(Collection<DestinationFlowConfig> destinationFlowConfigList)

The configuration that controls how Amazon AppFlow places data in the destination connector.

Parameters:

destinationFlowConfigList - The configuration that controls how Amazon AppFlow places data in the destination connector.

Returns:

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

getTasks

public List<Task> getTasks()

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

setTasks

public void setTasks(Collection<Task> tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Parameters:

tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

withTasks

public CreateFlowRequest withTasks(Task... tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

NOTE: This method appends the values to the existing list (if any). Use setTasks(java.util.Collection) or withTasks(java.util.Collection) if you want to override the existing values.

Parameters:

tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:

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

withTasks

public CreateFlowRequest withTasks(Collection<Task> tasks)

A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Parameters:

tasks - A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

Returns:

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

getTags

public Map<String,String> getTags()

The tags used to organize, track, or control access for your flow.

Returns:

The tags used to organize, track, or control access for your flow.

setTags

public void setTags(Map<String,String> tags)

The tags used to organize, track, or control access for your flow.

Parameters:

tags - The tags used to organize, track, or control access for your flow.

withTags

public CreateFlowRequest withTags(Map<String,String> tags)

The tags used to organize, track, or control access for your flow.

Parameters:

tags - The tags used to organize, track, or control access for your flow.

Returns:

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

addTagsEntry

public CreateFlowRequest addTagsEntry(String key,
                                      String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateFlowRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setMetadataCatalogConfig

public void setMetadataCatalogConfig(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.

Parameters:

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.

getMetadataCatalogConfig

public MetadataCatalogConfig getMetadataCatalogConfig()

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.

Returns:

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.

withMetadataCatalogConfig

public CreateFlowRequest withMetadataCatalogConfig(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.

Parameters:

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.

Returns:

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

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

Returns:

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.

withClientToken

public CreateFlowRequest withClientToken(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.

Parameters:

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.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateFlowRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()