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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameterFilters() Returns true if the ParameterFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

path

public final String path()

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. 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 (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. 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 final 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/b, they can still call the GetParametersByPath API action recursively for /a 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/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

hasParameterFilters

public final boolean hasParameterFilters()

Returns true if the ParameterFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameterFilters

public final List<ParameterStringFilter> parameterFilters()

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

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

You can use hasParameterFilters() to see if a value was sent in this field.

Returns:

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

withDecryption

public final 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 final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static GetParametersByPathRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo