Package 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

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

Method Summary

Modifier and Type	Method	Description
ListSecretsRequest.Builder	filters(Collection<Filter> filters)	The filters to apply to the list of secrets.
ListSecretsRequest.Builder	filters(Consumer<Filter.Builder>... filters)	The filters to apply to the list of secrets.
ListSecretsRequest.Builder	filters(Filter... filters)	The filters to apply to the list of secrets.
ListSecretsRequest.Builder	includePlannedDeletion(Boolean includePlannedDeletion)	Specifies whether to include secrets scheduled for deletion.
ListSecretsRequest.Builder	maxResults(Integer maxResults)	The number of results to include in the response.
ListSecretsRequest.Builder	nextToken(String nextToken)	A token that indicates where the output should continue from, if a previous call did not show all results.
ListSecretsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListSecretsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListSecretsRequest.Builder	sortOrder(String sortOrder)	Secrets are listed by CreatedDate.
ListSecretsRequest.Builder	sortOrder(SortOrderType sortOrder)	Secrets are listed by CreatedDate.

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

overrideConfiguration

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

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

build

Method Detail

includePlannedDeletion

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

maxResults

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

nextToken

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

filters

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

filters

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

filters

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

The filters to apply to the list of secrets.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

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

Returns:

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

See Also:

#filters(java.util.Collection)

sortOrder

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

sortOrder

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