AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticBeanstalk::Model::SearchFilter Class Reference

#include <SearchFilter.h>

Public Member Functions

 SearchFilter ()
 
 SearchFilter (const Aws::Utils::Xml::XmlNode &xmlNode)
 
SearchFilteroperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetAttribute () const
 
bool AttributeHasBeenSet () const
 
void SetAttribute (const Aws::String &value)
 
void SetAttribute (Aws::String &&value)
 
void SetAttribute (const char *value)
 
SearchFilterWithAttribute (const Aws::String &value)
 
SearchFilterWithAttribute (Aws::String &&value)
 
SearchFilterWithAttribute (const char *value)
 
const Aws::StringGetOperator () const
 
bool OperatorHasBeenSet () const
 
void SetOperator (const Aws::String &value)
 
void SetOperator (Aws::String &&value)
 
void SetOperator (const char *value)
 
SearchFilterWithOperator (const Aws::String &value)
 
SearchFilterWithOperator (Aws::String &&value)
 
SearchFilterWithOperator (const char *value)
 
const Aws::Vector< Aws::String > & GetValues () const
 
bool ValuesHasBeenSet () const
 
void SetValues (const Aws::Vector< Aws::String > &value)
 
void SetValues (Aws::Vector< Aws::String > &&value)
 
SearchFilterWithValues (const Aws::Vector< Aws::String > &value)
 
SearchFilterWithValues (Aws::Vector< Aws::String > &&value)
 
SearchFilterAddValues (const Aws::String &value)
 
SearchFilterAddValues (Aws::String &&value)
 
SearchFilterAddValues (const char *value)
 

Detailed Description

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

See Also:

AWS API Reference

Definition at line 41 of file SearchFilter.h.

Constructor & Destructor Documentation

◆ SearchFilter() [1/2]

Aws::ElasticBeanstalk::Model::SearchFilter::SearchFilter ( )

◆ SearchFilter() [2/2]

Aws::ElasticBeanstalk::Model::SearchFilter::SearchFilter ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddValues() [1/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::AddValues ( const Aws::String value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 197 of file SearchFilter.h.

◆ AddValues() [2/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::AddValues ( Aws::String &&  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 204 of file SearchFilter.h.

◆ AddValues() [3/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::AddValues ( const char *  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 211 of file SearchFilter.h.

◆ AttributeHasBeenSet()

bool Aws::ElasticBeanstalk::Model::SearchFilter::AttributeHasBeenSet ( ) const
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 62 of file SearchFilter.h.

◆ GetAttribute()

const Aws::String& Aws::ElasticBeanstalk::Model::SearchFilter::GetAttribute ( ) const
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 56 of file SearchFilter.h.

◆ GetOperator()

const Aws::String& Aws::ElasticBeanstalk::Model::SearchFilter::GetOperator ( ) const
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 105 of file SearchFilter.h.

◆ GetValues()

const Aws::Vector<Aws::String>& Aws::ElasticBeanstalk::Model::SearchFilter::GetValues ( ) const
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 155 of file SearchFilter.h.

◆ operator=()

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OperatorHasBeenSet()

bool Aws::ElasticBeanstalk::Model::SearchFilter::OperatorHasBeenSet ( ) const
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 111 of file SearchFilter.h.

◆ OutputToStream() [1/2]

void Aws::ElasticBeanstalk::Model::SearchFilter::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::ElasticBeanstalk::Model::SearchFilter::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ SetAttribute() [1/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetAttribute ( const Aws::String value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 68 of file SearchFilter.h.

◆ SetAttribute() [2/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetAttribute ( Aws::String &&  value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 74 of file SearchFilter.h.

◆ SetAttribute() [3/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetAttribute ( const char *  value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 80 of file SearchFilter.h.

◆ SetOperator() [1/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetOperator ( const Aws::String value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 117 of file SearchFilter.h.

◆ SetOperator() [2/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetOperator ( Aws::String &&  value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 123 of file SearchFilter.h.

◆ SetOperator() [3/3]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetOperator ( const char *  value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 129 of file SearchFilter.h.

◆ SetValues() [1/2]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetValues ( const Aws::Vector< Aws::String > &  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 169 of file SearchFilter.h.

◆ SetValues() [2/2]

void Aws::ElasticBeanstalk::Model::SearchFilter::SetValues ( Aws::Vector< Aws::String > &&  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 176 of file SearchFilter.h.

◆ ValuesHasBeenSet()

bool Aws::ElasticBeanstalk::Model::SearchFilter::ValuesHasBeenSet ( ) const
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 162 of file SearchFilter.h.

◆ WithAttribute() [1/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithAttribute ( const Aws::String value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 86 of file SearchFilter.h.

◆ WithAttribute() [2/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithAttribute ( Aws::String &&  value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 92 of file SearchFilter.h.

◆ WithAttribute() [3/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithAttribute ( const char *  value)
inline

The result attribute to which the filter values are applied. Valid values vary by API action.

Definition at line 98 of file SearchFilter.h.

◆ WithOperator() [1/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithOperator ( const Aws::String value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 135 of file SearchFilter.h.

◆ WithOperator() [2/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithOperator ( Aws::String &&  value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 141 of file SearchFilter.h.

◆ WithOperator() [3/3]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithOperator ( const char *  value)
inline

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Definition at line 147 of file SearchFilter.h.

◆ WithValues() [1/2]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithValues ( const Aws::Vector< Aws::String > &  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 183 of file SearchFilter.h.

◆ WithValues() [2/2]

SearchFilter& Aws::ElasticBeanstalk::Model::SearchFilter::WithValues ( Aws::Vector< Aws::String > &&  value)
inline

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

Definition at line 190 of file SearchFilter.h.


The documentation for this class was generated from the following file: