Class: Google::Apis::CloudsearchV1::QueryOperator

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

The definition of a operator that can be used in a Search/Suggest request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryOperator

Returns a new instance of QueryOperator.



13658
13659
13660
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13658

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_nameString

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String)


13591
13592
13593
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13591

def display_name
  @display_name
end

#enum_valuesArray<String>

Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator. Corresponds to the JSON property enumValues

Returns:

  • (Array<String>)


13597
13598
13599
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13597

def enum_values
  @enum_values
end

#greater_than_operator_nameString

Indicates the operator name that can be used to isolate the property using the greater-than operator. Corresponds to the JSON property greaterThanOperatorName

Returns:

  • (String)


13603
13604
13605
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13603

def greater_than_operator_name
  @greater_than_operator_name
end

#is_facetableBoolean Also known as: is_facetable?

Can this operator be used to get facets. Corresponds to the JSON property isFacetable

Returns:

  • (Boolean)


13608
13609
13610
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13608

def is_facetable
  @is_facetable
end

#is_repeatableBoolean Also known as: is_repeatable?

Indicates if multiple values can be set for this property. Corresponds to the JSON property isRepeatable

Returns:

  • (Boolean)


13614
13615
13616
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13614

def is_repeatable
  @is_repeatable
end

#is_returnableBoolean Also known as: is_returnable?

Will the property associated with this facet be returned as part of search results. Corresponds to the JSON property isReturnable

Returns:

  • (Boolean)


13621
13622
13623
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13621

def is_returnable
  @is_returnable
end

#is_sortableBoolean Also known as: is_sortable?

Can this operator be used to sort results. Corresponds to the JSON property isSortable

Returns:

  • (Boolean)


13627
13628
13629
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13627

def is_sortable
  @is_sortable
end

#is_suggestableBoolean Also known as: is_suggestable?

Can get suggestions for this field. Corresponds to the JSON property isSuggestable

Returns:

  • (Boolean)


13633
13634
13635
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13633

def is_suggestable
  @is_suggestable
end

#less_than_operator_nameString

Indicates the operator name that can be used to isolate the property using the less-than operator. Corresponds to the JSON property lessThanOperatorName

Returns:

  • (String)


13640
13641
13642
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13640

def less_than_operator_name
  @less_than_operator_name
end

#object_typeString

The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators. Corresponds to the JSON property objectType

Returns:

  • (String)


13646
13647
13648
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13646

def object_type
  @object_type
end

#operator_nameString

The name of the operator. Corresponds to the JSON property operatorName

Returns:

  • (String)


13651
13652
13653
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13651

def operator_name
  @operator_name
end

#typeString

The type of the operator. Corresponds to the JSON property type

Returns:

  • (String)


13656
13657
13658
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13656

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 13663

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enum_values = args[:enum_values] if args.key?(:enum_values)
  @greater_than_operator_name = args[:greater_than_operator_name] if args.key?(:greater_than_operator_name)
  @is_facetable = args[:is_facetable] if args.key?(:is_facetable)
  @is_repeatable = args[:is_repeatable] if args.key?(:is_repeatable)
  @is_returnable = args[:is_returnable] if args.key?(:is_returnable)
  @is_sortable = args[:is_sortable] if args.key?(:is_sortable)
  @is_suggestable = args[:is_suggestable] if args.key?(:is_suggestable)
  @less_than_operator_name = args[:less_than_operator_name] if args.key?(:less_than_operator_name)
  @object_type = args[:object_type] if args.key?(:object_type)
  @operator_name = args[:operator_name] if args.key?(:operator_name)
  @type = args[:type] if args.key?(:type)
end