@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ParameterStringFilter extends Object implements Serializable, Cloneable, StructuredPojo
One or more filters. Use a filter to return a more specific list of results.
Constructor and Description |
---|
ParameterStringFilter() |
Modifier and Type | Method and Description |
---|---|
ParameterStringFilter |
clone() |
boolean |
equals(Object obj) |
String |
getKey()
The name of the filter.
|
String |
getOption()
|
List<String> |
getValues()
The value you want to search for.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setKey(String key)
The name of the filter.
|
void |
setOption(String option)
|
void |
setValues(Collection<String> values)
The value you want to search for.
|
String |
toString()
Returns a string representation of this object.
|
ParameterStringFilter |
withKey(String key)
The name of the filter.
|
ParameterStringFilter |
withOption(String option)
|
ParameterStringFilter |
withValues(Collection<String> values)
The value you want to search for.
|
ParameterStringFilter |
withValues(String... values)
The value you want to search for.
|
public void setKey(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 for Key
can
be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
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 for
Key
can be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
public String getKey()
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 for Key
can
be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
The ParameterStringFilter
object is used by the DescribeParameters and
GetParametersByPath API operations. However, not all of the pattern values listed for
Key
can be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
public ParameterStringFilter withKey(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 for Key
can
be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
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 for
Key
can be used with both operations.
For DescribeParameters
, all of the listed patterns are valid except Label
.
For GetParametersByPath
, the following patterns listed for Key
aren't valid:
tag
, DataType
, Name
, Path
, and Tier
.
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.
public void setOption(String option)
For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option.
(Exception: For filters using the key Path
, valid options include Recursive
and
OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid option
is Equals
.)
option
- For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option. (Exception: For filters using the key Path
, valid options include
Recursive
and OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid
option is Equals
.)
public String getOption()
For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option.
(Exception: For filters using the key Path
, valid options include Recursive
and
OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid option
is Equals
.)
Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option. (Exception: For filters using the key Path
, valid options include
Recursive
and OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid
option is Equals
.)
public ParameterStringFilter withOption(String option)
For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option.
(Exception: For filters using the key Path
, valid options include Recursive
and
OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid option
is Equals
.)
option
- For all filters used with DescribeParameters, valid options include Equals
and
BeginsWith
. The Name
filter additionally supports the Contains
option. (Exception: For filters using the key Path
, valid options include
Recursive
and OneLevel
.)
For filters used with GetParametersByPath, valid options include Equals
and
BeginsWith
. (Exception: For filters using Label
as the Key name, the only valid
option is Equals
.)
public List<String> getValues()
The value you want to search for.
public void setValues(Collection<String> values)
The value you want to search for.
values
- The value you want to search for.public ParameterStringFilter withValues(String... values)
The value you want to search for.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
or withValues(java.util.Collection)
if you want to override the
existing values.
values
- The value you want to search for.public ParameterStringFilter withValues(Collection<String> values)
The value you want to search for.
values
- The value you want to search for.public String toString()
toString
in class Object
Object.toString()
public ParameterStringFilter clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.