Package 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("software.amazon.awssdk:codegen") public final class GetParametersByPathRequest extends SsmRequest implements ToCopyableBuilder<GetParametersByPathRequest.Builder,GetParametersByPathRequest>

  • Method Details

    • path

      public final String path()

      The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't 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 hierarchy is the parameter name except the last part of the parameter. For the API call to succeed, the last part of the parameter name can't 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 operation 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 operation recursively for /a and view /a/b.

    • hasParameterFilters

      public final boolean hasParameterFilters()
      For responses, this returns true if the service returned a value for the ParameterFilters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parameterFilters

      public final List<ParameterStringFilter> parameterFilters()

      Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, Name, Path, and Tier.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameterFilters() method.

      Returns:
      Filters to limit the request results.

      The following Key values are supported for GetParametersByPath: Type, KeyId, and Label.

      The following Key values aren't supported for GetParametersByPath: tag, DataType, 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo