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

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::FilterOptions

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

• #filter ⇒ Google::Apis::CloudsearchV1::Filter

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

• #object_type ⇒ String

  If object_type is set, only objects of that type are returned.

Instance Method Summary

• #initialize(**args) ⇒ FilterOptions constructor

  A new instance of FilterOptions.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1053

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

Instance Attribute Details

#filter ⇒ Google::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

Returns:

• (Google::Apis::CloudsearchV1::Filter)

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1044

def filter
  @filter
end

#object_type ⇒ String

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)

# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1051

def object_type
  @object_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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