Class CreatePipelineRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.datapipeline.model.CreatePipelineRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the parameters for CreatePipeline.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description CreatePipelineRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreatePipelineRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDescription()
The description for the pipeline.String
getName()
The name for the pipeline.List<Tag>
getTags()
A list of tags to associate with the pipeline at creation.String
getUniqueId()
A unique identifier.int
hashCode()
void
setDescription(String description)
The description for the pipeline.void
setName(String name)
The name for the pipeline.void
setTags(Collection<Tag> tags)
A list of tags to associate with the pipeline at creation.void
setUniqueId(String uniqueId)
A unique identifier.String
toString()
Returns a string representation of this object; useful for testing and debugging.CreatePipelineRequest
withDescription(String description)
The description for the pipeline.CreatePipelineRequest
withName(String name)
The name for the pipeline.CreatePipelineRequest
withTags(Tag... tags)
A list of tags to associate with the pipeline at creation.CreatePipelineRequest
withTags(Collection<Tag> tags)
A list of tags to associate with the pipeline at creation.CreatePipelineRequest
withUniqueId(String uniqueId)
A unique identifier.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setName
public void setName(String name)
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
- Parameters:
name
- The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
-
getName
public String getName()
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
- Returns:
- The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
-
withName
public CreatePipelineRequest withName(String name)
The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
- Parameters:
name
- The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUniqueId
public void setUniqueId(String uniqueId)
A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to
CreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.- Parameters:
uniqueId
- A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls toCreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.
-
getUniqueId
public String getUniqueId()
A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to
CreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.- Returns:
- A unique identifier. This identifier is not the same as the
pipeline identifier assigned by AWS Data Pipeline. You are
responsible for defining the format and ensuring the uniqueness
of this identifier. You use this parameter to ensure idempotency
during repeated calls to
CreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.
-
withUniqueId
public CreatePipelineRequest withUniqueId(String uniqueId)
A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to
CreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.- Parameters:
uniqueId
- A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls toCreatePipeline
. For example, if the first call toCreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call toCreatePipeline
.CreatePipeline
ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
The description for the pipeline.
- Parameters:
description
- The description for the pipeline.
-
getDescription
public String getDescription()
The description for the pipeline.
- Returns:
- The description for the pipeline.
-
withDescription
public CreatePipelineRequest withDescription(String description)
The description for the pipeline.
- Parameters:
description
- The description for the pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
public List<Tag> getTags()
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
- Returns:
- A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
-
setTags
public void setTags(Collection<Tag> tags)
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
- Parameters:
tags
- A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
-
withTags
public CreatePipelineRequest withTags(Tag... tags)
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreatePipelineRequest withTags(Collection<Tag> tags)
A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
- Parameters:
tags
- A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.- 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreatePipelineRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-