com.amazonaws.services.datapipeline.model

Class SetStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.SetStatusRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetStatusRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetStatus operation.

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException .

See Also:

DataPipeline.setStatus(SetStatusRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetStatusRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetStatusRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getObjectIds() The IDs of the objects.
String	getPipelineId() The ID of the pipeline that contains the objects.
String	getStatus() The status to be set on all the objects specified in objectIds.
int	hashCode()
void	setObjectIds(Collection<String> objectIds) The IDs of the objects.
void	setPipelineId(String pipelineId) The ID of the pipeline that contains the objects.
void	setStatus(String status) The status to be set on all the objects specified in objectIds.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetStatusRequest	withObjectIds(Collection<String> objectIds) The IDs of the objects.
SetStatusRequest	withObjectIds(String... objectIds) The IDs of the objects.
SetStatusRequest	withPipelineId(String pipelineId) The ID of the pipeline that contains the objects.
SetStatusRequest	withStatus(String status) The status to be set on all the objects specified in objectIds.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, 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

SetStatusRequest

public SetStatusRequest()

Method Detail

getPipelineId

public String getPipelineId()

The ID of the pipeline that contains the objects.

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

Returns:

The ID of the pipeline that contains the objects.

setPipelineId

public void setPipelineId(String pipelineId)

The ID of the pipeline that contains the objects.

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

Parameters:

pipelineId - The ID of the pipeline that contains the objects.

withPipelineId

public SetStatusRequest withPipelineId(String pipelineId)

The ID of the pipeline that contains the objects.

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 that contains the objects.

Returns:

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

getObjectIds

public List<String> getObjectIds()

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Returns:

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

setObjectIds

public void setObjectIds(Collection<String> objectIds)

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Parameters:

objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

withObjectIds

public SetStatusRequest withObjectIds(String... objectIds)

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

NOTE: This method appends the values to the existing list (if any). Use setObjectIds(java.util.Collection) or withObjectIds(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:

objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Returns:

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

withObjectIds

public SetStatusRequest withObjectIds(Collection<String> objectIds)

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

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

Parameters:

objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

Returns:

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

getStatus

public String getStatus()

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

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

Returns:

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

setStatus

public void setStatus(String status)

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

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

Parameters:

status - The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

withStatus

public SetStatusRequest withStatus(String status)

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

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

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

Parameters:

status - The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

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