com.amazonaws.services.datapipeline.model

Class ActivatePipelineRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.ActivatePipelineRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ActivatePipelineRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the ActivatePipeline operation.

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

See Also:

DataPipeline.activatePipeline(ActivatePipelineRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ActivatePipelineRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ActivatePipelineRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<ParameterValue>	getParameterValues() A list of parameter values to pass to the pipeline at activation.
String	getPipelineId() The ID of the pipeline.
Date	getStartTimestamp() The date and time to resume the pipeline.
int	hashCode()
void	setParameterValues(Collection<ParameterValue> parameterValues) A list of parameter values to pass to the pipeline at activation.
void	setPipelineId(String pipelineId) The ID of the pipeline.
void	setStartTimestamp(Date startTimestamp) The date and time to resume the pipeline.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ActivatePipelineRequest	withParameterValues(Collection<ParameterValue> parameterValues) A list of parameter values to pass to the pipeline at activation.
ActivatePipelineRequest	withParameterValues(ParameterValue... parameterValues) A list of parameter values to pass to the pipeline at activation.
ActivatePipelineRequest	withPipelineId(String pipelineId) The ID of the pipeline.
ActivatePipelineRequest	withStartTimestamp(Date startTimestamp) The date and time to resume the pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivatePipelineRequest

public ActivatePipelineRequest()

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 ActivatePipelineRequest 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.

getParameterValues

public List<ParameterValue> getParameterValues()

A list of parameter values to pass to the pipeline at activation.

Returns:

A list of parameter values to pass to the pipeline at activation.

setParameterValues

public void setParameterValues(Collection<ParameterValue> parameterValues)

A list of parameter values to pass to the pipeline at activation.

Parameters:

parameterValues - A list of parameter values to pass to the pipeline at activation.

withParameterValues

public ActivatePipelineRequest withParameterValues(ParameterValue... parameterValues)

A list of parameter values to pass to the pipeline at activation.

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 - A list of parameter values to pass to the pipeline at activation.

Returns:

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

withParameterValues

public ActivatePipelineRequest withParameterValues(Collection<ParameterValue> parameterValues)

A list of parameter values to pass to the pipeline at activation.

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

Parameters:

parameterValues - A list of parameter values to pass to the pipeline at activation.

Returns:

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

getStartTimestamp

public Date getStartTimestamp()

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

Returns:

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

setStartTimestamp

public void setStartTimestamp(Date startTimestamp)

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

Parameters:

startTimestamp - The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

withStartTimestamp

public ActivatePipelineRequest withStartTimestamp(Date startTimestamp)

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

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

Parameters:

startTimestamp - The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

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 ActivatePipelineRequest 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()