Package 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("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. For more information, see Find secrets in Secrets Manager.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method	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()	For responses, this returns true if the service returned a value for the Values property.
FilterNameStringType	key()	The following are keys you can use:
String	keyAsString()	The following are keys you can use:
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The keyword to filter 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 FilterNameStringType key()

The following are keys you can use:

• description: Prefix match, not case-sensitive.

• name: Prefix match, case-sensitive.

• tag-key: Prefix match, case-sensitive.

• tag-value: Prefix match, case-sensitive.

• primary-region: Prefix match, case-sensitive.

• owning-service: Prefix match, case-sensitive.

• all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

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:

The following are keys you can use:

• description: Prefix match, not case-sensitive.

• name: Prefix match, case-sensitive.

• tag-key: Prefix match, case-sensitive.

• tag-value: Prefix match, case-sensitive.

• primary-region: Prefix match, case-sensitive.

• owning-service: Prefix match, case-sensitive.

• all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

See Also:

FilterNameStringType

keyAsString

public final String keyAsString()

The following are keys you can use:

• description: Prefix match, not case-sensitive.

• name: Prefix match, case-sensitive.

• tag-key: Prefix match, case-sensitive.

• tag-value: Prefix match, case-sensitive.

• primary-region: Prefix match, case-sensitive.

• owning-service: Prefix match, case-sensitive.

• all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

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:

The following are keys you can use:

• description: Prefix match, not case-sensitive.

• name: Prefix match, case-sensitive.

• tag-key: Prefix match, case-sensitive.

• tag-value: Prefix match, case-sensitive.

• primary-region: Prefix match, case-sensitive.

• owning-service: Prefix match, case-sensitive.

• all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.

See Also:

FilterNameStringType

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 the isEmpty() 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 keyword to filter for.

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.

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 keyword to filter for.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo