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

Class GetParametersByPathRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetParametersByPathRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetParametersByPathRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetParametersByPathRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
Integer	maxResults()	The maximum number of items to return for this call.
String	nextToken()	A token to start the list.
List<ParameterStringFilter>	parameterFilters()	Filters to limit the request results.
String	path()	The hierarchy for the parameter.
Boolean	recursive()	Retrieve all parameters within a hierarchy.
static Class<? extends GetParametersByPathRequest.Builder>	serializableBuilderClass()
GetParametersByPathRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Boolean	withDecryption()	Retrieve all parameters in a hierarchy with their value decrypted.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

path

public 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

Returns:

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

recursive

public Boolean recursive()

Retrieve all parameters within a hierarchy.

Returns:

Retrieve all parameters within a hierarchy.

parameterFilters

public List<ParameterStringFilter> parameterFilters()

Filters to limit the request results.

Returns:

Filters to limit the request results.

withDecryption

public Boolean withDecryption()

Retrieve all parameters in a hierarchy with their value decrypted.

Returns:

Retrieve all parameters in a hierarchy with their value decrypted.

maxResults

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

Returns:

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.

nextToken

public String nextToken()

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

Returns:

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

toBuilder

public GetParametersByPathRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

Returns:

a builder for type T

builder

public static GetParametersByPathRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetParametersByPathRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object