com.amazonaws.services.datapipeline.model

Class PutPipelineDefinitionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest

All Implemented Interfaces:

Serializable

public class PutPipelineDefinitionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the PutPipelineDefinition operation.

Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline or to update an existing pipeline that has not yet been activated.

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.

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

See Also:

DataPipeline.putPipelineDefinition(PutPipelineDefinitionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
PutPipelineDefinitionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPipelineId() The identifier of the pipeline to be configured.
List<PipelineObject>	getPipelineObjects() The objects that define the pipeline.
int	hashCode()
void	setPipelineId(String pipelineId) The identifier of the pipeline to be configured.
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	withPipelineId(String pipelineId) The identifier of the pipeline to be configured.
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

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutPipelineDefinitionRequest

public PutPipelineDefinitionRequest()

Method Detail

getPipelineId

public String getPipelineId()

The identifier of the pipeline to be configured.

Constraints:
Length: 1 - 1024
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Returns:

The identifier of the pipeline to be configured.

setPipelineId

public void setPipelineId(String pipelineId)

The identifier of the pipeline to be configured.

Constraints:
Length: 1 - 1024
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

pipelineId - The identifier of the pipeline to be configured.

withPipelineId

public PutPipelineDefinitionRequest withPipelineId(String pipelineId)

The identifier of the pipeline to be configured.

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

Constraints:
Length: 1 - 1024
Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

Parameters:

pipelineId - The identifier of the pipeline to be configured.

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 will overwrite the existing pipeline definition.

Returns:

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

setPipelineObjects

public void setPipelineObjects(Collection<PipelineObject> pipelineObjects)

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

Parameters:

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

withPipelineObjects

public PutPipelineDefinitionRequest withPipelineObjects(PipelineObject... pipelineObjects)

The objects that define the pipeline. These will 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 will 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 will 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 will overwrite the existing pipeline definition.

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