@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Contains the parameters for CreatePipeline.
NOOP
Constructor and Description |
---|
CreatePipelineRequest() |
Modifier and Type | Method and Description |
---|---|
CreatePipelineRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
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.
|
CreatePipelineRequest |
withDescription(String description)
The description for the pipeline.
|
CreatePipelineRequest |
withName(String name)
The name for the pipeline.
|
CreatePipelineRequest |
withTags(Collection<Tag> tags)
A list of tags to associate with the pipeline at creation.
|
CreatePipelineRequest |
withTags(Tag... tags)
A list of tags to associate with the pipeline at creation.
|
CreatePipelineRequest |
withUniqueId(String uniqueId)
A unique identifier.
|
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
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.
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.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.
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.
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.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 to CreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline
name combination on a subsequent call to CreatePipeline
. 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.
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 to CreatePipeline
does not succeed, you can pass in the same
unique identifier and pipeline name combination on a subsequent call to CreatePipeline
.
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.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 to CreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline
name combination on a subsequent call to CreatePipeline
. 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.
CreatePipeline
. For
example, if the first call to CreatePipeline
does not succeed, you can pass in the same
unique identifier and pipeline name combination on a subsequent call to CreatePipeline
.
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.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 to CreatePipeline
does not succeed, you can pass in the same unique identifier and pipeline
name combination on a subsequent call to CreatePipeline
. 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.
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 to CreatePipeline
does not succeed, you can pass in the same
unique identifier and pipeline name combination on a subsequent call to CreatePipeline
.
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.public void setDescription(String description)
The description for the pipeline.
description
- The description for the pipeline.public String getDescription()
The description for the pipeline.
public CreatePipelineRequest withDescription(String description)
The description for the pipeline.
description
- The description for the pipeline.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.
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.
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.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)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.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.
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.public String toString()
toString
in class Object
Object.toString()
public CreatePipelineRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()