Class CreatePipelineRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Contains the parameters for CreatePipeline.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The description for the pipeline.getName()
The name for the pipeline.getTags()
A list of tags to associate with the pipeline at creation.A unique identifier.int
hashCode()
void
setDescription
(String description) The description for the pipeline.void
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.toString()
Returns a string representation of this object; useful for testing and debugging.withDescription
(String description) The description for the pipeline.The name for the pipeline.A list of tags to associate with the pipeline at creation.withTags
(Collection<Tag> tags) A list of tags to associate with the pipeline at creation.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
-
Constructor Details
-
CreatePipelineRequest
public CreatePipelineRequest()
-
-
Method Details
-
setName
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
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
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
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
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
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
The description for the pipeline.
- Parameters:
description
- The description for the pipeline.
-
getDescription
The description for the pipeline.
- Returns:
- The description for the pipeline.
-
withDescription
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-