Class ParameterStringFilter
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.ParameterStringFilter
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
@Generated("software.amazon.awssdk:codegen") public final class ParameterStringFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
One or more filters. Use a filter to return a more specific list of results.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ParameterStringFilter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ParameterStringFilter.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasValues()
For responses, this returns true if the service returned a value for the Values property.String
key()
The name of the filter.String
option()
List<SdkField<?>>
sdkFields()
static Class<? extends ParameterStringFilter.Builder>
serializableBuilderClass()
ParameterStringFilter.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
values()
The value you want to search for.-
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
-
key
public final 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.
- Returns:
- 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.
-
option
public final 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
.)- Returns:
- 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
.)
-
hasValues
public final boolean hasValues()
For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
values
public final List<String> values()
The value you want to search for.
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
hasValues()
method.- Returns:
- The value you want to search for.
-
toBuilder
public ParameterStringFilter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>
-
builder
public static ParameterStringFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends ParameterStringFilter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-