com.amazonaws.services.secretsmanager.model

Class ListSecretsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.secretsmanager.model.ListSecretsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
ListSecretsRequest	clone()
boolean	equals(Object obj)
List<Filter>	getFilters() Lists the secret request filters.
Integer	getMaxResults() (Optional) Limits the number of results you want to include in the response.
String	getNextToken() (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available.
String	getSortOrder() Lists secrets in the requested order.
int	hashCode()
void	setFilters(Collection<Filter> filters) Lists the secret request filters.
void	setMaxResults(Integer maxResults) (Optional) Limits the number of results you want to include in the response.
void	setNextToken(String nextToken) (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available.
void	setSortOrder(String sortOrder) Lists secrets in the requested order.
String	toString() Returns a string representation of this object.
ListSecretsRequest	withFilters(Collection<Filter> filters) Lists the secret request filters.
ListSecretsRequest	withFilters(Filter... filters) Lists the secret request filters.
ListSecretsRequest	withMaxResults(Integer maxResults) (Optional) Limits the number of results you want to include in the response.
ListSecretsRequest	withNextToken(String nextToken) (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available.
ListSecretsRequest	withSortOrder(SortOrderType sortOrder) Lists secrets in the requested order.
ListSecretsRequest	withSortOrder(String sortOrder) Lists secrets in the requested order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

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

Constructor Detail

ListSecretsRequest

public ListSecretsRequest()

Method Detail

setMaxResults

public void setMaxResults(Integer maxResults)

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - (Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

getMaxResults

public Integer getMaxResults()

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

withMaxResults

public ListSecretsRequest withMaxResults(Integer maxResults)

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Parameters:

maxResults - (Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Parameters:

nextToken - (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

getNextToken

public String getNextToken()

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Returns:

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

withNextToken

public ListSecretsRequest withNextToken(String nextToken)

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Parameters:

nextToken - (Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Returns:

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

getFilters

public List<Filter> getFilters()

Lists the secret request filters.

Returns:

Lists the secret request filters.

setFilters

public void setFilters(Collection<Filter> filters)

Lists the secret request filters.

Parameters:

filters - Lists the secret request filters.

withFilters

public ListSecretsRequest withFilters(Filter... filters)

Lists the secret request filters.

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 - Lists the secret request filters.

Returns:

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

withFilters

public ListSecretsRequest withFilters(Collection<Filter> filters)

Lists the secret request filters.

Parameters:

filters - Lists the secret request filters.

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

Lists secrets in the requested order.

Parameters:

sortOrder - Lists secrets in the requested order.

See Also:

SortOrderType

getSortOrder

public String getSortOrder()

Lists secrets in the requested order.

Returns:

Lists secrets in the requested order.

See Also:

SortOrderType

withSortOrder

public ListSecretsRequest withSortOrder(String sortOrder)

Lists secrets in the requested order.

Parameters:

sortOrder - Lists secrets in the requested order.

Returns:

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

See Also:

SortOrderType

withSortOrder

public ListSecretsRequest withSortOrder(SortOrderType sortOrder)

Lists secrets in the requested order.

Parameters:

sortOrder - Lists secrets in the requested order.

Returns:

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

See Also:

SortOrderType

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 ListSecretsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest