software.amazon.awssdk.services.ssm.model

Interface GetParametersByPathRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>, SdkBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>, SdkRequest.Builder, SSMRequest.Builder

Enclosing class:

GetParametersByPathRequest

public static interface GetParametersByPathRequest.Builder
extends SSMRequest.Builder, CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

Method Summary

Modifier and Type	Method and Description
GetParametersByPathRequest.Builder	maxResults(Integer maxResults) The maximum number of items to return for this call.
GetParametersByPathRequest.Builder	nextToken(String nextToken) A token to start the list.
GetParametersByPathRequest.Builder	parameterFilters(Collection<ParameterStringFilter> parameterFilters) Filters to limit the request results.
GetParametersByPathRequest.Builder	parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters) Filters to limit the request results.
GetParametersByPathRequest.Builder	parameterFilters(ParameterStringFilter... parameterFilters) Filters to limit the request results.
GetParametersByPathRequest.Builder	path(String path) The hierarchy for the parameter.
GetParametersByPathRequest.Builder	recursive(Boolean recursive) Retrieve all parameters within a hierarchy.
GetParametersByPathRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
GetParametersByPathRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
GetParametersByPathRequest.Builder	withDecryption(Boolean withDecryption) Retrieve all parameters in a hierarchy with their value decrypted.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

path

GetParametersByPathRequest.Builder path(String path)

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. For example: /Finance/Prod/IAD/WinServ2016/license15

Parameters:

path - The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A hierarchy can have a maximum of five levels. For example: /Finance/Prod/IAD/WinServ2016/license15

Returns:

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

recursive

GetParametersByPathRequest.Builder recursive(Boolean recursive)

Retrieve all parameters within a hierarchy.

Parameters:

recursive - Retrieve all parameters within a hierarchy.

Returns:

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

parameterFilters

GetParametersByPathRequest.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

GetParametersByPathRequest.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

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

Filters to limit the request results.

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 #parameterFilters(List).

Parameters:

parameterFilters - 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:

#parameterFilters(List)

withDecryption

GetParametersByPathRequest.Builder withDecryption(Boolean withDecryption)

Retrieve all parameters in a hierarchy with their value decrypted.

Parameters:

withDecryption - Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

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

maxResults

GetParametersByPathRequest.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

GetParametersByPathRequest.Builder nextToken(String nextToken)

A token to start the list. Use this token to get the next set of results.

Parameters:

nextToken - A token to start the list. Use this token to get the next set of results.

Returns:

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

requestOverrideConfig

GetParametersByPathRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

GetParametersByPathRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.