Interface ParameterStringFilter.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
,SdkBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
,SdkPojo
- Enclosing class:
- ParameterStringFilter
public static interface ParameterStringFilter.Builder extends SdkPojo, CopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ParameterStringFilter.Builder
key(String key)
The name of the filter.ParameterStringFilter.Builder
option(String option)
ParameterStringFilter.Builder
values(String... values)
The value you want to search for.ParameterStringFilter.Builder
values(Collection<String> values)
The value you want to search for.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
key
ParameterStringFilter.Builder key(String key)
The name of the filter.
The
ParameterStringFilter
object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed forKey
can be used with both operations.For
DescribeParameters
, all of the listed patterns are valid exceptLabel
.For
GetParametersByPath
, the following patterns listed forKey
aren't valid:tag
,DataType
,Name
,Path
, andTier
.For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
- Parameters:
key
- The name of the filter.The
ParameterStringFilter
object is used by the DescribeParameters and GetParametersByPath API operations. However, not all of the pattern values listed forKey
can be used with both operations.For
DescribeParameters
, all of the listed patterns are valid exceptLabel
.For
GetParametersByPath
, the following patterns listed forKey
aren't valid:tag
,DataType
,Name
,Path
, andTier
.For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
option
ParameterStringFilter.Builder option(String option)
For all filters used with DescribeParameters, valid options include
Equals
andBeginsWith
. TheName
filter additionally supports theContains
option. (Exception: For filters using the keyPath
, valid options includeRecursive
andOneLevel
.)For filters used with GetParametersByPath, valid options include
Equals
andBeginsWith
. (Exception: For filters usingLabel
as the Key name, the only valid option isEquals
.)- Parameters:
option
- For all filters used with DescribeParameters, valid options includeEquals
andBeginsWith
. TheName
filter additionally supports theContains
option. (Exception: For filters using the keyPath
, valid options includeRecursive
andOneLevel
.)For filters used with GetParametersByPath, valid options include
Equals
andBeginsWith
. (Exception: For filters usingLabel
as the Key name, the only valid option isEquals
.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
ParameterStringFilter.Builder values(Collection<String> values)
The value you want to search for.
- Parameters:
values
- The value you want to search for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
values
ParameterStringFilter.Builder values(String... values)
The value you want to search for.
- Parameters:
values
- The value you want to search for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-