com.amazonaws.services.appflow.model.CreateFlowRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-appflow Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.appflow.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFlowRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*
*/
private String flowName;
/**
*
* A description of the flow you want to create.
*
*/
private String description;
/**
*
* 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.
*
*/
private String kmsArn;
/**
*
* The trigger settings that determine how and when the flow runs.
*
*/
private TriggerConfig triggerConfig;
/**
*
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*
*/
private SourceFlowConfig sourceFlowConfig;
/**
*
* The configuration that controls how Amazon AppFlow places data in the destination connector.
*
*/
private java.util.List destinationFlowConfigList;
/**
*
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*
*/
private java.util.List tasks;
/**
*
* The tags used to organize, track, or control access for your flow.
*
*/
private java.util.Map tags;
/**
*
* 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.
*
*/
private MetadataCatalogConfig metadataCatalogConfig;
/**
*
* 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.
*
*/
private String clientToken;
/**
*
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*
*
* @param flowName
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*/
public void setFlowName(String flowName) {
this.flowName = flowName;
}
/**
*
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*
*
* @return The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*/
public String getFlowName() {
return this.flowName;
}
/**
*
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
*
*
* @param flowName
* The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withFlowName(String flowName) {
setFlowName(flowName);
return this;
}
/**
*
* A description of the flow you want to create.
*
*
* @param description
* A description of the flow you want to create.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the flow you want to create.
*
*
* @return A description of the flow you want to create.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the flow you want to create.
*
*
* @param description
* A description of the flow you want to create.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setKmsArn(String kmsArn) {
this.kmsArn = 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.
*
*
* @return 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 String getKmsArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withKmsArn(String kmsArn) {
setKmsArn(kmsArn);
return this;
}
/**
*
* The trigger settings that determine how and when the flow runs.
*
*
* @param triggerConfig
* The trigger settings that determine how and when the flow runs.
*/
public void setTriggerConfig(TriggerConfig triggerConfig) {
this.triggerConfig = triggerConfig;
}
/**
*
* The trigger settings that determine how and when the flow runs.
*
*
* @return The trigger settings that determine how and when the flow runs.
*/
public TriggerConfig getTriggerConfig() {
return this.triggerConfig;
}
/**
*
* The trigger settings that determine how and when the flow runs.
*
*
* @param triggerConfig
* The trigger settings that determine how and when the flow runs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withTriggerConfig(TriggerConfig triggerConfig) {
setTriggerConfig(triggerConfig);
return this;
}
/**
*
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*
*
* @param sourceFlowConfig
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*/
public void setSourceFlowConfig(SourceFlowConfig sourceFlowConfig) {
this.sourceFlowConfig = sourceFlowConfig;
}
/**
*
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*
*
* @return The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*/
public SourceFlowConfig getSourceFlowConfig() {
return this.sourceFlowConfig;
}
/**
*
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
*
*
* @param sourceFlowConfig
* The configuration that controls how Amazon AppFlow retrieves data from the source connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withSourceFlowConfig(SourceFlowConfig sourceFlowConfig) {
setSourceFlowConfig(sourceFlowConfig);
return this;
}
/**
*
* The configuration that controls how Amazon AppFlow places data in the destination connector.
*
*
* @return The configuration that controls how Amazon AppFlow places data in the destination connector.
*/
public java.util.List getDestinationFlowConfigList() {
return destinationFlowConfigList;
}
/**
*
* The configuration that controls how Amazon AppFlow places data in the destination connector.
*
*
* @param destinationFlowConfigList
* The configuration that controls how Amazon AppFlow places data in the destination connector.
*/
public void setDestinationFlowConfigList(java.util.Collection destinationFlowConfigList) {
if (destinationFlowConfigList == null) {
this.destinationFlowConfigList = null;
return;
}
this.destinationFlowConfigList = new java.util.ArrayList(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
* {@link #setDestinationFlowConfigList(java.util.Collection)} or
* {@link #withDestinationFlowConfigList(java.util.Collection)} if you want to override the existing values.
*
*
* @param destinationFlowConfigList
* The configuration that controls how Amazon AppFlow places data in the destination connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withDestinationFlowConfigList(DestinationFlowConfig... destinationFlowConfigList) {
if (this.destinationFlowConfigList == null) {
setDestinationFlowConfigList(new java.util.ArrayList(destinationFlowConfigList.length));
}
for (DestinationFlowConfig ele : destinationFlowConfigList) {
this.destinationFlowConfigList.add(ele);
}
return this;
}
/**
*
* The configuration that controls how Amazon AppFlow places data in the destination connector.
*
*
* @param destinationFlowConfigList
* The configuration that controls how Amazon AppFlow places data in the destination connector.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withDestinationFlowConfigList(java.util.Collection destinationFlowConfigList) {
setDestinationFlowConfigList(destinationFlowConfigList);
return this;
}
/**
*
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*
*
* @return A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*/
public java.util.List getTasks() {
return tasks;
}
/**
*
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*
*
* @param tasks
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*/
public void setTasks(java.util.Collection tasks) {
if (tasks == null) {
this.tasks = null;
return;
}
this.tasks = new java.util.ArrayList(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
* {@link #setTasks(java.util.Collection)} or {@link #withTasks(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tasks
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withTasks(Task... tasks) {
if (this.tasks == null) {
setTasks(new java.util.ArrayList(tasks.length));
}
for (Task ele : tasks) {
this.tasks.add(ele);
}
return this;
}
/**
*
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
*
*
* @param tasks
* A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withTasks(java.util.Collection tasks) {
setTasks(tasks);
return this;
}
/**
*
* The tags used to organize, track, or control access for your flow.
*
*
* @return The tags used to organize, track, or control access for your flow.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The tags used to organize, track, or control access for your flow.
*
*
* @param tags
* The tags used to organize, track, or control access for your flow.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The tags used to organize, track, or control access for your flow.
*
*
* @param tags
* The tags used to organize, track, or control access for your flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateFlowRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* 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.
*
*
* @param 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 void setMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig) {
this.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.
*
*
* @return 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 MetadataCatalogConfig getMetadataCatalogConfig() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withMetadataCatalogConfig(MetadataCatalogConfig metadataCatalogConfig) {
setMetadataCatalogConfig(metadataCatalogConfig);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setClientToken(String clientToken) {
this.clientToken = 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.
*
*
* @return 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.
*/
public String getClientToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFlowRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFlowName() != null)
sb.append("FlowName: ").append(getFlowName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getKmsArn() != null)
sb.append("KmsArn: ").append(getKmsArn()).append(",");
if (getTriggerConfig() != null)
sb.append("TriggerConfig: ").append(getTriggerConfig()).append(",");
if (getSourceFlowConfig() != null)
sb.append("SourceFlowConfig: ").append(getSourceFlowConfig()).append(",");
if (getDestinationFlowConfigList() != null)
sb.append("DestinationFlowConfigList: ").append(getDestinationFlowConfigList()).append(",");
if (getTasks() != null)
sb.append("Tasks: ").append(getTasks()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getMetadataCatalogConfig() != null)
sb.append("MetadataCatalogConfig: ").append(getMetadataCatalogConfig()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateFlowRequest == false)
return false;
CreateFlowRequest other = (CreateFlowRequest) obj;
if (other.getFlowName() == null ^ this.getFlowName() == null)
return false;
if (other.getFlowName() != null && other.getFlowName().equals(this.getFlowName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getKmsArn() == null ^ this.getKmsArn() == null)
return false;
if (other.getKmsArn() != null && other.getKmsArn().equals(this.getKmsArn()) == false)
return false;
if (other.getTriggerConfig() == null ^ this.getTriggerConfig() == null)
return false;
if (other.getTriggerConfig() != null && other.getTriggerConfig().equals(this.getTriggerConfig()) == false)
return false;
if (other.getSourceFlowConfig() == null ^ this.getSourceFlowConfig() == null)
return false;
if (other.getSourceFlowConfig() != null && other.getSourceFlowConfig().equals(this.getSourceFlowConfig()) == false)
return false;
if (other.getDestinationFlowConfigList() == null ^ this.getDestinationFlowConfigList() == null)
return false;
if (other.getDestinationFlowConfigList() != null && other.getDestinationFlowConfigList().equals(this.getDestinationFlowConfigList()) == false)
return false;
if (other.getTasks() == null ^ this.getTasks() == null)
return false;
if (other.getTasks() != null && other.getTasks().equals(this.getTasks()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getMetadataCatalogConfig() == null ^ this.getMetadataCatalogConfig() == null)
return false;
if (other.getMetadataCatalogConfig() != null && other.getMetadataCatalogConfig().equals(this.getMetadataCatalogConfig()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFlowName() == null) ? 0 : getFlowName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getKmsArn() == null) ? 0 : getKmsArn().hashCode());
hashCode = prime * hashCode + ((getTriggerConfig() == null) ? 0 : getTriggerConfig().hashCode());
hashCode = prime * hashCode + ((getSourceFlowConfig() == null) ? 0 : getSourceFlowConfig().hashCode());
hashCode = prime * hashCode + ((getDestinationFlowConfigList() == null) ? 0 : getDestinationFlowConfigList().hashCode());
hashCode = prime * hashCode + ((getTasks() == null) ? 0 : getTasks().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getMetadataCatalogConfig() == null) ? 0 : getMetadataCatalogConfig().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateFlowRequest clone() {
return (CreateFlowRequest) super.clone();
}
}