@Generated(value="software.amazon.awssdk:codegen") public final class GetParametersByPathRequest extends SsmRequest implements ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetParametersByPathRequest.Builder |
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.
|
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.
|
overrideConfiguration
copy
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. For example: /Finance/Prod/IAD/WinServ2016/license15
/Finance/Prod/IAD/WinServ2016/license15
public Boolean recursive()
Retrieve all parameters within a hierarchy.
public List<ParameterStringFilter> parameterFilters()
Filters to limit the request results.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Boolean withDecryption()
Retrieve all parameters in a hierarchy with their value decrypted.
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.
public String nextToken()
A token to start the list. Use this token to get the next set of results.
public GetParametersByPathRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>
toBuilder
in class SsmRequest
public static GetParametersByPathRequest.Builder builder()
public static Class<? extends GetParametersByPathRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.