Package software.amazon.awssdk.services.ssm.model

Interface DescribeParametersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>, SdkBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DescribeParametersRequest

public static interface DescribeParametersRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>

Method Summary

Modifier and Type	Method	Description
DescribeParametersRequest.Builder	filters(Collection<ParametersFilter> filters)	This data type is deprecated.
DescribeParametersRequest.Builder	filters(Consumer<ParametersFilter.Builder>... filters)	This data type is deprecated.
DescribeParametersRequest.Builder	filters(ParametersFilter... filters)	This data type is deprecated.
DescribeParametersRequest.Builder	maxResults(Integer maxResults)	The maximum number of items to return for this call.
DescribeParametersRequest.Builder	nextToken(String nextToken)	The token for the next set of items to return.
DescribeParametersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeParametersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeParametersRequest.Builder	parameterFilters(Collection<ParameterStringFilter> parameterFilters)	Filters to limit the request results.
DescribeParametersRequest.Builder	parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters)	Filters to limit the request results.
DescribeParametersRequest.Builder	parameterFilters(ParameterStringFilter... parameterFilters)	Filters to limit the request results.
DescribeParametersRequest.Builder	shared(Boolean shared)	Lists parameters that are shared with you.

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, sdkFields

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Method Details

filters

DescribeParametersRequest.Builder filters(Collection<ParametersFilter> filters)

This data type is deprecated. Instead, use ParameterFilters.

Parameters:

filters - This data type is deprecated. Instead, use ParameterFilters.

Returns:

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

filters

DescribeParametersRequest.Builder filters(ParametersFilter... filters)

This data type is deprecated. Instead, use ParameterFilters.

Parameters:

filters - This data type is deprecated. Instead, use ParameterFilters.

Returns:

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

filters

DescribeParametersRequest.Builder filters(Consumer<ParametersFilter.Builder>... filters)

This data type is deprecated. Instead, use ParameterFilters.

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

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

Parameters:

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

Returns:

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

See Also:

• filters(java.util.Collection<ParametersFilter>)

parameterFilters

DescribeParametersRequest.Builder parameterFilters(Collection<ParameterStringFilter> parameterFilters)

Filters to limit the request results.

Parameters:

parameterFilters - Filters to limit the request results.

Returns:

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

parameterFilters

DescribeParametersRequest.Builder parameterFilters(ParameterStringFilter... parameterFilters)

Filters to limit the request results.

Parameters:

parameterFilters - Filters to limit the request results.

Returns:

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

parameterFilters

DescribeParametersRequest.Builder parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters)

Filters to limit the request results.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterFilters(List<ParameterStringFilter>).

Parameters:

parameterFilters - a consumer that will call methods on ParameterStringFilter.Builder

Returns:

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

See Also:

• parameterFilters(java.util.Collection<ParameterStringFilter>)

maxResults

DescribeParametersRequest.Builder maxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

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

nextToken

DescribeParametersRequest.Builder nextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Returns:

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

shared

DescribeParametersRequest.Builder shared(Boolean shared)

Lists parameters that are shared with you.

By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Parameters:

shared - Lists parameters that are shared with you.

By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated RAM Resource Share Created From Policy must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.

For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

Returns:

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

overrideConfiguration

DescribeParametersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.