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

Interface GetParametersByPathRequest.Builder

All Superinterfaces:

CopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>, SdkBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

Enclosing class:

GetParametersByPathRequest

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

Method Summary

Modifier and Type	Method	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(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	withDecryption(Boolean withDecryption)	Retrieve all parameters in a hierarchy with their value decrypted.

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. Examples: /Environment/Test/DBString003

/Finance/Prod/IAD/OS/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. Examples: /Environment/Test/DBString003

/Finance/Prod/IAD/OS/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.

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

Parameters:

parameterFilters - Filters to limit the request results.

Returns:

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

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.