com.amazonaws.services.simplesystemsmanagement.model

Class ParameterStringFilter

java.lang.Object

com.amazonaws.services.simplesystemsmanagement.model.ParameterStringFilter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

One or more filters. Use a filter to return a more specific list of results.

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API actions. However, not all of the pattern values listed for Key can be used with both actions.

For DescribeActions, all of the listed patterns are valid, with the exception of Label.

For GetParametersByPath, the following patterns listed for Key are not valid: Name, Path, and Tier.

For examples of CLI commands demonstrating valid parameter filter constructions, see Searching for Systems Manager Parameters in the AWS Systems Manager User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterStringFilter()

Method Summary

Modifier and Type	Method and Description
ParameterStringFilter	clone()
boolean	equals(Object obj)
String	getKey() The name of the filter.
String	getOption() For all filters used with DescribeParameters, valid options include Equals and BeginsWith.
List<String>	getValues() The value you want to search for.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKey(String key) The name of the filter.
void	setOption(String option) For all filters used with DescribeParameters, valid options include Equals and BeginsWith.
void	setValues(Collection<String> values) The value you want to search for.
String	toString() Returns a string representation of this object.
ParameterStringFilter	withKey(String key) The name of the filter.
ParameterStringFilter	withOption(String option) For all filters used with DescribeParameters, valid options include Equals and BeginsWith.
ParameterStringFilter	withValues(Collection<String> values) The value you want to search for.
ParameterStringFilter	withValues(String... values) The value you want to search for.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterStringFilter

public ParameterStringFilter()

Method Detail

setKey

public void setKey(String key)

The name of the filter.

Parameters:

key - The name of the filter.

getKey

public String getKey()

The name of the filter.

Returns:

The name of the filter.

withKey

public ParameterStringFilter withKey(String key)

The name of the filter.

Parameters:

key - The name of the filter.

Returns:

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

setOption

public void setOption(String option)

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

Parameters:

option - For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

getOption

public String getOption()

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

Returns:

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

withOption

public ParameterStringFilter withOption(String option)

For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

Parameters:

option - For all filters used with DescribeParameters, valid options include Equals and BeginsWith. The Name filter additionally supports the Contains option. (Exception: For filters using the key Path, valid options include Recursive and OneLevel.)

For filters used with GetParametersByPath, valid options include Equals and BeginsWith. (Exception: For filters using the key Label, the only valid option is Equals.)

Returns:

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

getValues

public List<String> getValues()

The value you want to search for.

Returns:

The value you want to search for.

setValues

public void setValues(Collection<String> values)

The value you want to search for.

Parameters:

values - The value you want to search for.

withValues

public ParameterStringFilter withValues(String... values)

The value you want to search for.

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 value you want to search for.

Returns:

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

withValues

public ParameterStringFilter withValues(Collection<String> values)

The value you want to search for.

Parameters:

values - The value you want to search for.

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 ParameterStringFilter clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.