com.amazonaws.services.datapipeline.model
Class CreatePipelineRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.datapipeline.model.CreatePipelineRequest

All Implemented Interfaces:

Serializable

public class CreatePipelineRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CreatePipeline operation.

Creates a new empty pipeline. When this action succeeds, you can then use the PutPipelineDefinition action to populate the pipeline.

See Also:

DataPipeline.createPipeline(CreatePipelineRequest), Serialized Form

Constructor Summary

CreatePipelineRequest()

Method Summary

boolean	equals(Object obj)
String	getDescription() The description of the new pipeline.
String	getName() The name of the new pipeline.
String	getUniqueId() A unique identifier that you specify.
int	hashCode()
void	setDescription(String description) The description of the new pipeline.
void	setName(String name) The name of the new pipeline.
void	setUniqueId(String uniqueId) A unique identifier that you specify.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePipelineRequest	withDescription(String description) The description of the new pipeline.
CreatePipelineRequest	withName(String name) The name of the new pipeline.
CreatePipelineRequest	withUniqueId(String uniqueId) A unique identifier that you specify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePipelineRequest

public CreatePipelineRequest()

Method Detail

getName

public String getName()

The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Returns:

The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

setName

public void setName(String name)

The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

name - The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

withName

public CreatePipelineRequest withName(String name)

The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

name - The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.

Returns:

A reference to this updated object so that method calls can be chained together.

getUniqueId

public String getUniqueId()

A unique identifier that you specify. 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 return a clear success, 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 will not be 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.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Returns:

A unique identifier that you specify. 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 return a clear success, 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 will not be 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.

setUniqueId

public void setUniqueId(String uniqueId)

A unique identifier that you specify. 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 return a clear success, 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 will not be 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.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

uniqueId - A unique identifier that you specify. 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 return a clear success, 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 will not be 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 that you specify. 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 return a clear success, 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 will not be 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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

uniqueId - A unique identifier that you specify. 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 return a clear success, 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 will not be 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 reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

The description of the new pipeline.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Returns:

The description of the new pipeline.

setDescription

public void setDescription(String description)

The description of the new pipeline.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

description - The description of the new pipeline.

withDescription

public CreatePipelineRequest withDescription(String description)

The description of the new pipeline.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 1024
Pattern: [ -??-??-?\r\n\t]*

Parameters:

description - The description of the new pipeline.

Returns:

A reference to this updated 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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object