com.amazonaws.services.simplesystemsmanagement.model

Class ListDocumentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.ListDocumentsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListDocumentsRequest
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
ListDocumentsRequest()

Method Summary

Modifier and Type	Method and Description
ListDocumentsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<DocumentFilter>	getDocumentFilterList() This data type is deprecated.
List<DocumentKeyValuesFilter>	getFilters() One or more DocumentKeyValuesFilter objects.
Integer	getMaxResults() The maximum number of items to return for this call.
String	getNextToken() The token for the next set of items to return.
int	hashCode()
void	setDocumentFilterList(Collection<DocumentFilter> documentFilterList) This data type is deprecated.
void	setFilters(Collection<DocumentKeyValuesFilter> filters) One or more DocumentKeyValuesFilter objects.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this call.
void	setNextToken(String nextToken) The token for the next set of items to return.
String	toString() Returns a string representation of this object.
ListDocumentsRequest	withDocumentFilterList(Collection<DocumentFilter> documentFilterList) This data type is deprecated.
ListDocumentsRequest	withDocumentFilterList(DocumentFilter... documentFilterList) This data type is deprecated.
ListDocumentsRequest	withFilters(Collection<DocumentKeyValuesFilter> filters) One or more DocumentKeyValuesFilter objects.
ListDocumentsRequest	withFilters(DocumentKeyValuesFilter... filters) One or more DocumentKeyValuesFilter objects.
ListDocumentsRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this call.
ListDocumentsRequest	withNextToken(String nextToken) The token for the next set of items to return.

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

ListDocumentsRequest

public ListDocumentsRequest()

Method Detail

getDocumentFilterList

public List<DocumentFilter> getDocumentFilterList()

This data type is deprecated. Instead, use Filters.

Returns:

This data type is deprecated. Instead, use Filters.

setDocumentFilterList

public void setDocumentFilterList(Collection<DocumentFilter> documentFilterList)

This data type is deprecated. Instead, use Filters.

Parameters:

documentFilterList - This data type is deprecated. Instead, use Filters.

withDocumentFilterList

public ListDocumentsRequest withDocumentFilterList(DocumentFilter... documentFilterList)

This data type is deprecated. Instead, use Filters.

NOTE: This method appends the values to the existing list (if any). Use setDocumentFilterList(java.util.Collection) or withDocumentFilterList(java.util.Collection) if you want to override the existing values.

Parameters:

documentFilterList - This data type is deprecated. Instead, use Filters.

Returns:

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

withDocumentFilterList

public ListDocumentsRequest withDocumentFilterList(Collection<DocumentFilter> documentFilterList)

This data type is deprecated. Instead, use Filters.

Parameters:

documentFilterList - This data type is deprecated. Instead, use Filters.

Returns:

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

getFilters

public List<DocumentKeyValuesFilter> getFilters()

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Returns:

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

setFilters

public void setFilters(Collection<DocumentKeyValuesFilter> filters)

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Parameters:

filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

withFilters

public ListDocumentsRequest withFilters(DocumentKeyValuesFilter... filters)

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Returns:

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

withFilters

public ListDocumentsRequest withFilters(Collection<DocumentKeyValuesFilter> filters)

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Parameters:

filters - One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

This API operation only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

getMaxResults

public Integer getMaxResults()

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

withMaxResults

public ListDocumentsRequest withMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

getNextToken

public String getNextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

withNextToken

public ListDocumentsRequest withNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

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