@Generated(value="software.amazon.awssdk:codegen") public final class CreatePipelineRequest extends DataPipelineRequest implements ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>
Contains the parameters for CreatePipeline.
Modifier and Type | Class and Description |
---|---|
static interface |
CreatePipelineRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreatePipelineRequest.Builder |
builder() |
String |
description()
The description for the pipeline.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
name()
The name for the pipeline.
|
static Class<? extends CreatePipelineRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of tags to associate with the pipeline at creation.
|
CreatePipelineRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
uniqueId()
A unique identifier.
|
overrideConfiguration
copy
public 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.
public 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.
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 description()
The description for the pipeline.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreatePipelineRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>
toBuilder
in class DataPipelineRequest
public static CreatePipelineRequest.Builder builder()
public static Class<? extends CreatePipelineRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.