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.



3596
3597
3598
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3596

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

Instance Attribute Details

#display_name ⇒ String

Display name of the operator Corresponds to the JSON property displayName

Returns:

  • (String) 


3529
3530
3531
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3529

def display_name
  @display_name
end

#enum_values ⇒ Array<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>) 


3535
3536
3537
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3535

def enum_values
  @enum_values
end

#greater_than_operator_name ⇒ String

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) 


3541
3542
3543
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3541

def greater_than_operator_name
  @greater_than_operator_name
end

#is_facetable ⇒ Boolean Also known as: is_facetable?

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

Returns:

  • (Boolean) 


3546
3547
3548
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3546

def is_facetable
  @is_facetable
end

#is_repeatable ⇒ Boolean Also known as: is_repeatable?

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

Returns:

  • (Boolean) 


3552
3553
3554
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3552

def is_repeatable
  @is_repeatable
end

#is_returnable ⇒ Boolean 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) 


3559
3560
3561
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3559

def is_returnable
  @is_returnable
end

#is_sortable ⇒ Boolean Also known as: is_sortable?

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

Returns:

  • (Boolean) 


3565
3566
3567
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3565

def is_sortable
  @is_sortable
end

#is_suggestable ⇒ Boolean Also known as: is_suggestable?

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

Returns:

  • (Boolean) 


3571
3572
3573
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3571

def is_suggestable
  @is_suggestable
end

#less_than_operator_name ⇒ String

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) 


3578
3579
3580
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3578

def less_than_operator_name
  @less_than_operator_name
end

#object_type ⇒ String

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) 


3584
3585
3586
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3584

def object_type
  @object_type
end

#operator_name ⇒ String

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

Returns:

  • (String) 


3589
3590
3591
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3589

def operator_name
  @operator_name
end

#type ⇒ String

Type of the operator. Corresponds to the JSON property type

Returns:

  • (String) 


3594
3595
3596
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3594

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3601

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