software.amazon.awssdk.services.secretsmanager.model

Interface ListSecretsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>, SdkBuilder<ListSecretsRequest.Builder,ListSecretsRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder

Enclosing class:

ListSecretsRequest

public static interface ListSecretsRequest.Builder
extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<ListSecretsRequest.Builder,ListSecretsRequest>

Method Summary

Modifier and Type	Method and Description
ListSecretsRequest.Builder	filters(Collection<Filter> filters) Lists the secret request filters.
ListSecretsRequest.Builder	filters(Consumer<Filter.Builder>... filters) Lists the secret request filters.
ListSecretsRequest.Builder	filters(Filter... filters) Lists the secret request filters.
ListSecretsRequest.Builder	maxResults(Integer maxResults) (Optional) Limits the number of results you want to include in the response.
ListSecretsRequest.Builder	nextToken(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.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListSecretsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListSecretsRequest.Builder	sortOrder(SortOrderType sortOrder) Lists secrets in the requested order.
ListSecretsRequest.Builder	sortOrder(String sortOrder) Lists secrets in the requested order.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

maxResults

ListSecretsRequest.Builder maxResults(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.

nextToken

ListSecretsRequest.Builder nextToken(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.

filters

ListSecretsRequest.Builder filters(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.

filters

ListSecretsRequest.Builder filters(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.

filters

ListSecretsRequest.Builder filters(Consumer<Filter.Builder>... filters)

Lists the secret request filters.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

sortOrder

ListSecretsRequest.Builder sortOrder(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, SortOrderType

sortOrder

ListSecretsRequest.Builder sortOrder(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, SortOrderType

overrideConfiguration

ListSecretsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListSecretsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder