Class: Google::Apis::CloudsearchV1::FilterOptions

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

Overview

Filter options to be applied on query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FilterOptions

Returns a new instance of FilterOptions



1066
1067
1068
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1066

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

Instance Attribute Details

#filterGoogle::Apis::CloudsearchV1::Filter

A generic way of expressing filters in a query, which supports two approaches:

1. Setting a ValueFilter. The name must match an operator_name defined in the schema for your data source.
2. Setting a CompositeFilter. The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND. Corresponds to the JSON property filter



1057
1058
1059
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1057

def filter
  @filter
end

#object_typeString

If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters. Corresponds to the JSON property objectType

Returns:

  • (String)


1064
1065
1066
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1064

def object_type
  @object_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1071
1072
1073
1074
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1071

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @object_type = args[:object_type] if args.key?(:object_type)
end