Class: Aws::ElasticBeanstalk::Types::SearchFilter

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass SearchFilter data as a hash:

{
  attribute: "SearchFilterAttribute",
  operator: "SearchFilterOperator",
  values: ["SearchFilterValue"],
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4421

class SearchFilter < Struct.new(
  :attribute,
  :operator,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#operatorString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4421

class SearchFilter < Struct.new(
  :attribute,
  :operator,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#valuesArray<String>

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

Returns:

  • (Array<String>)


4421
4422
4423
4424
4425
4426
4427
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 4421

class SearchFilter < Struct.new(
  :attribute,
  :operator,
  :values)
  SENSITIVE = []
  include Aws::Structure
end