com.amazonaws.services.datapipeline.model

Class PutPipelineDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutPipelineDefinitionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutPipelineDefinition operation.

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

1. An object is missing a name or identifier field.
2. A string or reference field is empty.
3. The number of objects in the pipeline exceeds the maximum allowed objects.
4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

See Also:

DataPipeline.putPipelineDefinition(PutPipelineDefinitionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutPipelineDefinitionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutPipelineDefinitionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<ParameterObject>	getParameterObjects() The parameter objects used with the pipeline.
List<ParameterValue>	getParameterValues() The parameter values used with the pipeline.
String	getPipelineId() The ID of the pipeline.
List<PipelineObject>	getPipelineObjects() The objects that define the pipeline.
int	hashCode()
void	setParameterObjects(Collection<ParameterObject> parameterObjects) The parameter objects used with the pipeline.
void	setParameterValues(Collection<ParameterValue> parameterValues) The parameter values used with the pipeline.
void	setPipelineId(String pipelineId) The ID of the pipeline.
void	setPipelineObjects(Collection<PipelineObject> pipelineObjects) The objects that define the pipeline.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutPipelineDefinitionRequest	withParameterObjects(Collection<ParameterObject> parameterObjects) The parameter objects used with the pipeline.
PutPipelineDefinitionRequest	withParameterObjects(ParameterObject... parameterObjects) The parameter objects used with the pipeline.
PutPipelineDefinitionRequest	withParameterValues(Collection<ParameterValue> parameterValues) The parameter values used with the pipeline.
PutPipelineDefinitionRequest	withParameterValues(ParameterValue... parameterValues) The parameter values used with the pipeline.
PutPipelineDefinitionRequest	withPipelineId(String pipelineId) The ID of the pipeline.
PutPipelineDefinitionRequest	withPipelineObjects(Collection<PipelineObject> pipelineObjects) The objects that define the pipeline.
PutPipelineDefinitionRequest	withPipelineObjects(PipelineObject... pipelineObjects) The objects that define the pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutPipelineDefinitionRequest

public PutPipelineDefinitionRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The ID of the pipeline.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

withPipelineId

public PutPipelineDefinitionRequest withPipelineId(String pipelineId)

The ID of the pipeline.

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

pipelineId - The ID of the pipeline.

Returns:

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

getPipelineObjects

public List<PipelineObject> getPipelineObjects()

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Returns:

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

setPipelineObjects

public void setPipelineObjects(Collection<PipelineObject> pipelineObjects)

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Parameters:

pipelineObjects - The objects that define the pipeline. These objects overwrite the existing pipeline definition.

withPipelineObjects

public PutPipelineDefinitionRequest withPipelineObjects(PipelineObject... pipelineObjects)

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

NOTE: This method appends the values to the existing list (if any). Use setPipelineObjects(java.util.Collection) or withPipelineObjects(java.util.Collection) if you want to override the existing values.

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

Parameters:

pipelineObjects - The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Returns:

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

withPipelineObjects

public PutPipelineDefinitionRequest withPipelineObjects(Collection<PipelineObject> pipelineObjects)

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

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

Parameters:

pipelineObjects - The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Returns:

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

getParameterObjects

public List<ParameterObject> getParameterObjects()

The parameter objects used with the pipeline.

Returns:

The parameter objects used with the pipeline.

setParameterObjects

public void setParameterObjects(Collection<ParameterObject> parameterObjects)

The parameter objects used with the pipeline.

Parameters:

parameterObjects - The parameter objects used with the pipeline.

withParameterObjects

public PutPipelineDefinitionRequest withParameterObjects(ParameterObject... parameterObjects)

The parameter objects used with the pipeline.

NOTE: This method appends the values to the existing list (if any). Use setParameterObjects(java.util.Collection) or withParameterObjects(java.util.Collection) if you want to override the existing values.

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

Parameters:

parameterObjects - The parameter objects used with the pipeline.

Returns:

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

withParameterObjects

public PutPipelineDefinitionRequest withParameterObjects(Collection<ParameterObject> parameterObjects)

The parameter objects used with the pipeline.

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

Parameters:

parameterObjects - The parameter objects used with the pipeline.

Returns:

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

getParameterValues

public List<ParameterValue> getParameterValues()

The parameter values used with the pipeline.

Returns:

The parameter values used with the pipeline.

setParameterValues

public void setParameterValues(Collection<ParameterValue> parameterValues)

The parameter values used with the pipeline.

Parameters:

parameterValues - The parameter values used with the pipeline.

withParameterValues

public PutPipelineDefinitionRequest withParameterValues(ParameterValue... parameterValues)

The parameter values used with the pipeline.

NOTE: This method appends the values to the existing list (if any). Use setParameterValues(java.util.Collection) or withParameterValues(java.util.Collection) if you want to override the existing values.

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

Parameters:

parameterValues - The parameter values used with the pipeline.

Returns:

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

withParameterValues

public PutPipelineDefinitionRequest withParameterValues(Collection<ParameterValue> parameterValues)

The parameter values used with the pipeline.

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

Parameters:

parameterValues - The parameter values used with the 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

clone

public PutPipelineDefinitionRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()