com.amazonaws.services.datapipeline.model

Class SetStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.SetStatusRequest

All Implemented Interfaces:

Serializable

public class SetStatusRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the SetStatus operation.

Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.

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
boolean	equals(Object obj)
List<String>	getObjectIds() Identifies an array of objects.
String	getPipelineId() Identifies the pipeline that contains the objects.
String	getStatus() Specifies the status to be set on all the objects in objectIds.
int	hashCode()
void	setObjectIds(Collection<String> objectIds) Identifies an array of objects.
void	setPipelineId(String pipelineId) Identifies the pipeline that contains the objects.
void	setStatus(String status) Specifies the status to be set on all the objects in objectIds.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetStatusRequest	withObjectIds(Collection<String> objectIds) Identifies an array of objects.
SetStatusRequest	withObjectIds(String... objectIds) Identifies an array of objects.
SetStatusRequest	withPipelineId(String pipelineId) Identifies the pipeline that contains the objects.
SetStatusRequest	withStatus(String status) Specifies the status to be set on all the objects in objectIds.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetStatusRequest

public SetStatusRequest()

Method Detail

getPipelineId

public String getPipelineId()

Identifies the pipeline that contains the objects.

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

Returns:

Identifies the pipeline that contains the objects.

setPipelineId

public void setPipelineId(String pipelineId)

Identifies the pipeline that contains the objects.

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

Parameters:

pipelineId - Identifies the pipeline that contains the objects.

withPipelineId

public SetStatusRequest withPipelineId(String pipelineId)

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

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

Returns:

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

setObjectIds

public void setObjectIds(Collection<String> objectIds)

Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.

Parameters:

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

withObjectIds

public SetStatusRequest withObjectIds(String... objectIds)

Identifies an array of 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 - Identifies an array of 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)

Identifies an array of 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 - Identifies an array of 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()

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

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

Returns:

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

setStatus

public void setStatus(String status)

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

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

Parameters:

status - Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either CANCEL, RERUN, or MARK_FINISHED.

withStatus

public SetStatusRequest withStatus(String status)

Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either 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 - Specifies the status to be set on all the objects in objectIds. For components, this can be either PAUSE or RESUME. For instances, this can be either 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