com.amazonaws.services.secretsmanager.model

Class BatchGetSecretValueRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.secretsmanager.model.BatchGetSecretValueRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
BatchGetSecretValueRequest	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 choose which secrets to retrieve.
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.
List<String>	getSecretIdList() The ARN or names of the secrets to retrieve.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters to choose which secrets to retrieve.
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	setSecretIdList(Collection<String> secretIdList) The ARN or names of the secrets to retrieve.
String	toString() Returns a string representation of this object.
BatchGetSecretValueRequest	withFilters(Collection<Filter> filters) The filters to choose which secrets to retrieve.
BatchGetSecretValueRequest	withFilters(Filter... filters) The filters to choose which secrets to retrieve.
BatchGetSecretValueRequest	withMaxResults(Integer maxResults) The number of results to include in the response.
BatchGetSecretValueRequest	withNextToken(String nextToken) A token that indicates where the output should continue from, if a previous call did not show all results.
BatchGetSecretValueRequest	withSecretIdList(Collection<String> secretIdList) The ARN or names of the secrets to retrieve.
BatchGetSecretValueRequest	withSecretIdList(String... secretIdList) The ARN or names of the secrets to retrieve.

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

BatchGetSecretValueRequest

public BatchGetSecretValueRequest()

Method Detail

getSecretIdList

public List<String> getSecretIdList()

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

setSecretIdList

public void setSecretIdList(Collection<String> secretIdList)

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Parameters:

secretIdList - The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

withSecretIdList

public BatchGetSecretValueRequest withSecretIdList(String... secretIdList)

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

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

Parameters:

secretIdList - The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

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

withSecretIdList

public BatchGetSecretValueRequest withSecretIdList(Collection<String> secretIdList)

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Parameters:

secretIdList - The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

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

getFilters

public List<Filter> getFilters()

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

setFilters

public void setFilters(Collection<Filter> filters)

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Parameters:

filters - The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

withFilters

public BatchGetSecretValueRequest withFilters(Filter... filters)

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

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 choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

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

withFilters

public BatchGetSecretValueRequest withFilters(Collection<Filter> filters)

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Parameters:

filters - The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

Returns:

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

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

withMaxResults

public BatchGetSecretValueRequest 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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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 BatchGetSecretValue 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 BatchGetSecretValue 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 BatchGetSecretValue 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 BatchGetSecretValue again with this value.

withNextToken

public BatchGetSecretValueRequest 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 BatchGetSecretValue 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 BatchGetSecretValue again with this value.

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