You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/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.

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)


1447
1448
1449
1450
1451
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1447

class Expression < Struct.new(
  :expression_name,
  :expression_value)
  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.

Returns:

  • (String)


1447
1448
1449
1450
1451
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1447

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