software.amazon.awssdk.services.secretsmanager.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.secretsmanager.model.Filter

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class Filter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Filter.Builder,Filter>

Allows you to add filters when you use the search function in Secrets Manager.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method and Description
static Filter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
FilterNameStringType	key() Filters your list of secrets by a specific key.
String	keyAsString() Filters your list of secrets by a specific key.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() Filters your list of secrets by a specific value.

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 FilterNameStringType key()

Filters your list of secrets by a specific key.

If the service returns an enum value that is not available in the current SDK version, key will return FilterNameStringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

Filters your list of secrets by a specific key.

See Also:

FilterNameStringType

keyAsString

public final String keyAsString()

Filters your list of secrets by a specific key.

If the service returns an enum value that is not available in the current SDK version, key will return FilterNameStringType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

Filters your list of secrets by a specific key.

See Also:

FilterNameStringType

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public final List<String> values()

Filters your list of secrets by a specific value.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

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

You can use hasValues() to see if a value was sent in this field.

Returns:

Filters your list of secrets by a specific value.

You can prefix your search value with an exclamation mark (!) in order to perform negation filters.

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo