com.amazonaws.services.secretsmanager.model

Class Filter

java.lang.Object

com.amazonaws.services.secretsmanager.model.Filter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Filter
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
Filter	clone()
boolean	equals(Object obj)
String	getKey() The following are keys you can use:
List<String>	getValues() The keyword to filter for.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setKey(String key) The following are keys you can use:
void	setValues(Collection<String> values) The keyword to filter for.
String	toString() Returns a string representation of this object.
Filter	withKey(FilterNameStringType key) The following are keys you can use:
Filter	withKey(String key) The following are keys you can use:
Filter	withValues(Collection<String> values) The keyword to filter for.
Filter	withValues(String... values) The keyword to filter for.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Filter

public Filter()

Method Detail

setKey

public void setKey(String 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.

Parameters:

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.

See Also:

FilterNameStringType

getKey

public String getKey()

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.

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

withKey

public Filter withKey(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FilterNameStringType

withKey

public Filter withKey(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FilterNameStringType

getValues

public List<String> getValues()

The keyword to filter for.

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

Returns:

The keyword to filter for.

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

setValues

public void setValues(Collection<String> values)

The keyword to filter for.

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

Parameters:

values - The keyword to filter for.

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

withValues

public Filter withValues(String... values)

The keyword to filter for.

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

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.

Parameters:

values - The keyword to filter for.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public Filter withValues(Collection<String> values)

The keyword to filter for.

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

Parameters:

values - The keyword to filter for.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Filter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo