Class: Aws::CloudSearch::Types::Expression

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

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

{
  expression_name: "StandardName", # required
  expression_value: "ExpressionValue", # required
}

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#expression_nameString

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

Returns:

  • (String)

1605
1606
1607
1608
1609
1610
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1605

class Expression < Struct.new(
  :expression_name,
  :expression_value)
  SENSITIVE = []
  include Aws::Structure
end

#expression_valueString

The expression to evaluate for sorting while processing a search request. The `Expression` syntax is based on JavaScript expressions. For more information, see [Configuring Expressions] in the *Amazon CloudSearch Developer Guide*.

[1]: docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html

Returns:

  • (String)

1605
1606
1607
1608
1609
1610
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1605

class Expression < Struct.new(
  :expression_name,
  :expression_value)
  SENSITIVE = []
  include Aws::Structure
end