com.amazonaws.services.pipes.model

Class ListPipesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pipes.model.ListPipesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListPipesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPipesRequest()

Method Summary

Modifier and Type	Method and Description
ListPipesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCurrentState() The state the pipe is in.
String	getDesiredState() The state the pipe should be in.
Integer	getLimit() The maximum number of pipes to include in the response.
String	getNamePrefix() A value that will return a subset of the pipes associated with this account.
String	getNextToken() If nextToken is returned, there are more results available.
String	getSourcePrefix() The prefix matching the pipe source.
String	getTargetPrefix() The prefix matching the pipe target.
int	hashCode()
void	setCurrentState(String currentState) The state the pipe is in.
void	setDesiredState(String desiredState) The state the pipe should be in.
void	setLimit(Integer limit) The maximum number of pipes to include in the response.
void	setNamePrefix(String namePrefix) A value that will return a subset of the pipes associated with this account.
void	setNextToken(String nextToken) If nextToken is returned, there are more results available.
void	setSourcePrefix(String sourcePrefix) The prefix matching the pipe source.
void	setTargetPrefix(String targetPrefix) The prefix matching the pipe target.
String	toString() Returns a string representation of this object.
ListPipesRequest	withCurrentState(PipeState currentState) The state the pipe is in.
ListPipesRequest	withCurrentState(String currentState) The state the pipe is in.
ListPipesRequest	withDesiredState(RequestedPipeState desiredState) The state the pipe should be in.
ListPipesRequest	withDesiredState(String desiredState) The state the pipe should be in.
ListPipesRequest	withLimit(Integer limit) The maximum number of pipes to include in the response.
ListPipesRequest	withNamePrefix(String namePrefix) A value that will return a subset of the pipes associated with this account.
ListPipesRequest	withNextToken(String nextToken) If nextToken is returned, there are more results available.
ListPipesRequest	withSourcePrefix(String sourcePrefix) The prefix matching the pipe source.
ListPipesRequest	withTargetPrefix(String targetPrefix) The prefix matching the pipe target.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPipesRequest

public ListPipesRequest()

Method Detail

setNamePrefix

public void setNamePrefix(String namePrefix)

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Parameters:

namePrefix - A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

getNamePrefix

public String getNamePrefix()

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Returns:

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

withNamePrefix

public ListPipesRequest withNamePrefix(String namePrefix)

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Parameters:

namePrefix - A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Returns:

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

setDesiredState

public void setDesiredState(String desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

See Also:

RequestedPipeState

getDesiredState

public String getDesiredState()

The state the pipe should be in.

Returns:

The state the pipe should be in.

See Also:

RequestedPipeState

withDesiredState

public ListPipesRequest withDesiredState(String desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

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

See Also:

RequestedPipeState

withDesiredState

public ListPipesRequest withDesiredState(RequestedPipeState desiredState)

The state the pipe should be in.

Parameters:

desiredState - The state the pipe should be in.

Returns:

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

See Also:

RequestedPipeState

setCurrentState

public void setCurrentState(String currentState)

The state the pipe is in.

Parameters:

currentState - The state the pipe is in.

See Also:

PipeState

getCurrentState

public String getCurrentState()

The state the pipe is in.

Returns:

The state the pipe is in.

See Also:

PipeState

withCurrentState

public ListPipesRequest withCurrentState(String currentState)

The state the pipe is in.

Parameters:

currentState - The state the pipe is in.

Returns:

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

See Also:

PipeState

withCurrentState

public ListPipesRequest withCurrentState(PipeState currentState)

The state the pipe is in.

Parameters:

currentState - The state the pipe is in.

Returns:

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

See Also:

PipeState

setSourcePrefix

public void setSourcePrefix(String sourcePrefix)

The prefix matching the pipe source.

Parameters:

sourcePrefix - The prefix matching the pipe source.

getSourcePrefix

public String getSourcePrefix()

The prefix matching the pipe source.

Returns:

The prefix matching the pipe source.

withSourcePrefix

public ListPipesRequest withSourcePrefix(String sourcePrefix)

The prefix matching the pipe source.

Parameters:

sourcePrefix - The prefix matching the pipe source.

Returns:

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

setTargetPrefix

public void setTargetPrefix(String targetPrefix)

The prefix matching the pipe target.

Parameters:

targetPrefix - The prefix matching the pipe target.

getTargetPrefix

public String getTargetPrefix()

The prefix matching the pipe target.

Returns:

The prefix matching the pipe target.

withTargetPrefix

public ListPipesRequest withTargetPrefix(String targetPrefix)

The prefix matching the pipe target.

Parameters:

targetPrefix - The prefix matching the pipe target.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameters:

nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

getNextToken

public String getNextToken()

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

withNextToken

public ListPipesRequest withNextToken(String nextToken)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Parameters:

nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

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

setLimit

public void setLimit(Integer limit)

The maximum number of pipes to include in the response.

Parameters:

limit - The maximum number of pipes to include in the response.

getLimit

public Integer getLimit()

The maximum number of pipes to include in the response.

Returns:

The maximum number of pipes to include in the response.

withLimit

public ListPipesRequest withLimit(Integer limit)

The maximum number of pipes to include in the response.

Parameters:

limit - The maximum number of pipes to include in the response.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListPipesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()