software.amazon.awssdk.services.ssm.model

Class GetParametersByPathRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetParametersByPathRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetParametersByPathRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
List<SdkField<?>>	sdkFields()
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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

path

public String path()

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Returns:

The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

recursive

public Boolean recursive()

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a, they can still call the GetParametersByPath API action recursively and view /a/b.

Returns:

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a, they can still call the GetParametersByPath API action recursively and view /a/b.

parameterFilters

public List<ParameterStringFilter> parameterFilters()

Filters to limit the request results.

You can't filter using the parameter name.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Filters to limit the request results.

You can't filter using the parameter name.

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>

Specified by:

toBuilder in class SsmRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.