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() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<Filter>	getFilters() The filters to apply to the list of secrets.
Boolean	getIncludePlannedDeletion() Specifies whether to include secrets scheduled for deletion.
Integer	getMaxResults() The number of results to include in the response.
String	getNextToken() A token that indicates where the output should continue from, if a previous call did not show all results.
String	getSortOrder() Secrets are listed by CreatedDate.
int	hashCode()
Boolean	isIncludePlannedDeletion() Specifies whether to include secrets scheduled for deletion.
void	setFilters(Collection<Filter> filters) The filters to apply to the list of secrets.
void	setIncludePlannedDeletion(Boolean includePlannedDeletion) Specifies whether to include secrets scheduled for deletion.
void	setMaxResults(Integer maxResults) The number of results to include in the response.
void	setNextToken(String nextToken) A token that indicates where the output should continue from, if a previous call did not show all results.
void	setSortOrder(String sortOrder) Secrets are listed by CreatedDate.
String	toString() Returns a string representation of this object.
ListSecretsRequest	withFilters(Collection<Filter> filters) The filters to apply to the list of secrets.
ListSecretsRequest	withFilters(Filter... filters) The filters to apply to the list of secrets.
ListSecretsRequest	withIncludePlannedDeletion(Boolean includePlannedDeletion) Specifies whether to include secrets scheduled for deletion.
ListSecretsRequest	withMaxResults(Integer maxResults) The number of results to include in the response.
ListSecretsRequest	withNextToken(String nextToken) A token that indicates where the output should continue from, if a previous call did not show all results.
ListSecretsRequest	withSortOrder(SortOrderType sortOrder) Secrets are listed by CreatedDate.
ListSecretsRequest	withSortOrder(String sortOrder) Secrets are listed by CreatedDate.

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

ListSecretsRequest

public ListSecretsRequest()

Method Detail

setIncludePlannedDeletion

public void setIncludePlannedDeletion(Boolean includePlannedDeletion)

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

Parameters:

includePlannedDeletion - Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

getIncludePlannedDeletion

public Boolean getIncludePlannedDeletion()

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

Returns:

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

withIncludePlannedDeletion

public ListSecretsRequest withIncludePlannedDeletion(Boolean includePlannedDeletion)

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

Parameters:

includePlannedDeletion - Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

Returns:

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

isIncludePlannedDeletion

public Boolean isIncludePlannedDeletion()

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

Returns:

Specifies whether to include secrets scheduled for deletion. By default, secrets scheduled for deletion aren't included.

setMaxResults

public void setMaxResults(Integer maxResults)

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

Parameters:

maxResults - The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

getMaxResults

public Integer getMaxResults()

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

Returns:

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

withMaxResults

public ListSecretsRequest withMaxResults(Integer maxResults)

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

Parameters:

maxResults - The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call ListSecrets again with the value from NextToken.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

Parameters:

nextToken - A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

getNextToken

public String getNextToken()

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

Returns:

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

withNextToken

public ListSecretsRequest withNextToken(String nextToken)

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

Parameters:

nextToken - A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets again with this value.

Returns:

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

getFilters

public List<Filter> getFilters()

The filters to apply to the list of secrets.

Returns:

The filters to apply to the list of secrets.

setFilters

public void setFilters(Collection<Filter> filters)

The filters to apply to the list of secrets.

Parameters:

filters - The filters to apply to the list of secrets.

withFilters

public ListSecretsRequest withFilters(Filter... filters)

The filters to apply to the list of secrets.

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 - The filters to apply to the list of secrets.

Returns:

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

withFilters

public ListSecretsRequest withFilters(Collection<Filter> filters)

The filters to apply to the list of secrets.

Parameters:

filters - The filters to apply to the list of secrets.

Returns:

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

setSortOrder

public void setSortOrder(String sortOrder)

Secrets are listed by CreatedDate.

Parameters:

sortOrder - Secrets are listed by CreatedDate.

See Also:

SortOrderType

getSortOrder

public String getSortOrder()

Secrets are listed by CreatedDate.

Returns:

Secrets are listed by CreatedDate.

See Also:

SortOrderType

withSortOrder

public ListSecretsRequest withSortOrder(String sortOrder)

Secrets are listed by CreatedDate.

Parameters:

sortOrder - Secrets are listed by CreatedDate.

Returns:

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

See Also:

SortOrderType

withSortOrder

public ListSecretsRequest withSortOrder(SortOrderType sortOrder)

Secrets are listed by CreatedDate.

Parameters:

sortOrder - Secrets are listed by CreatedDate.

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

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