public class CreatePipelineRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Contains the parameters for CreatePipeline.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
description
The description for the pipeline.
|
private java.lang.String |
name
The name for the pipeline.
|
private SdkInternalList<Tag> |
tags
A list of tags to associate with the pipeline at creation.
|
private java.lang.String |
uniqueId
A unique identifier.
|
NOOP
Constructor and Description |
---|
CreatePipelineRequest() |
Modifier and Type | Method and Description |
---|---|
CreatePipelineRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDescription()
The description for the pipeline.
|
java.lang.String |
getName()
The name for the pipeline.
|
java.util.List<Tag> |
getTags()
A list of tags to associate with the pipeline at creation.
|
java.lang.String |
getUniqueId()
A unique identifier.
|
int |
hashCode() |
void |
setDescription(java.lang.String description)
The description for the pipeline.
|
void |
setName(java.lang.String name)
The name for the pipeline.
|
void |
setTags(java.util.Collection<Tag> tags)
A list of tags to associate with the pipeline at creation.
|
void |
setUniqueId(java.lang.String uniqueId)
A unique identifier.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
CreatePipelineRequest |
withDescription(java.lang.String description)
The description for the pipeline.
|
CreatePipelineRequest |
withName(java.lang.String name)
The name for the pipeline.
|
CreatePipelineRequest |
withTags(java.util.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(java.lang.String uniqueId)
A unique identifier.
|
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
private java.lang.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.
private java.lang.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.
private java.lang.String description
The description for the pipeline.
private SdkInternalList<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.
public void setName(java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.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(java.lang.String description)
The description for the pipeline.
description
- The description for the pipeline.public java.lang.String getDescription()
The description for the pipeline.
public CreatePipelineRequest withDescription(java.lang.String description)
The description for the pipeline.
description
- The description for the pipeline.public java.util.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(java.util.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(java.util.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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public CreatePipelineRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()