software.amazon.awssdk.services.ssm.model

Class ParameterStringFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.ParameterStringFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>

@Generated(value="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.

The Name and Tier filter keys can't be used with the GetParametersByPath API action. Also, the Label filter key can't be used with the DescribeParameters API action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ParameterStringFilter.Builder

Method Summary

Modifier and Type	Method and Description
static ParameterStringFilter.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() The name of the filter.
String	option() Valid options are Equals and BeginsWith.
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 String key()

The name of the filter.

Returns:

The name of the filter.

option

public String option()

Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

Returns:

Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

values

public List<String> values()

The value you want to search for.

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

Returns:

The value you want to search for.

toBuilder

public ParameterStringFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterStringFilter.Builder,ParameterStringFilter>

builder

public static ParameterStringFilter.Builder builder()

serializableBuilderClass

public static Class<? extends ParameterStringFilter.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo