Class: Google::Apis::CloudsearchV1::FuseboxItemThreadMatchInfo

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

In the context of a search, the MatchInfo contains information about which Items matched the query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FuseboxItemThreadMatchInfo

Returns a new instance of FuseboxItemThreadMatchInfo.



9670
9671
9672
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9670

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

Instance Attribute Details

#cluster_id ⇒ String

If SearchQuery.Options.Clustering is present, the query will be treated as a cluster query, and this field may be populated with the cluster ID of the cluster to which this thread belongs, if any. The cluster ID will be a label on the message. Corresponds to the JSON property clusterId

Returns:

  • (String) 


9614
9615
9616
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9614

def cluster_id
  @cluster_id
end

#last_matching_item_id ⇒ Fixnum

The server id of the last item that matched the query. This is always set, regardless of the compute_matching_items_per_thread option. This is the value by which search results are sorted, in descending (i.e. newest first) order. Corresponds to the JSON property lastMatchingItemId

Returns:

  • (Fixnum) 


9621
9622
9623
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9621

def last_matching_item_id
  @last_matching_item_id
end

#last_matching_item_key ⇒ Google::Apis::CloudsearchV1::MultiKey

A union-like type for identifiying an object in storage. MultiKeys contain multiple key fields, each in a separate key space. At least one key field must be set. More than one key field may be set as long as all key values refer to the same object. All objects in storage have unique server_id keys. All MultiKeys returned from storage to storage clients will always have the server_id field set. When creating an object, if a MultiKey without a server_id is supplied to storage, the storage system will auto-assign a server ID to the new object. For all other storage requests (i.e. those not creating new objects), clients may omit server_id (as long as they supply another key). Instead of server ids, clients can specify string based client_assigned_perm_id keys. Mail message drafts are a prime example of these kinds of objects. Each time a user saves a new version of a draft, the storage system needs to create a new object with the updated draft content and needs to delete the object containing the old content. The new object gets a new SERVER_ID but should get the same CLIENT_ASSIGNED_PERM_ID as the now-deleted object containing the old content. Carrying forward the perm ID allows it to be used to consistently refer to the same logical object across revisions. These perm IDs save sync clients from having to deal with changing object IDs. For example, assume there's a mail message in storage with SERVER_ID = 123 and CLIENT_ASSIGNED_PERM_ID = "foo". The following are all valid ways of addressing the object using MultiKeys: 1) MultiKey server_id = 123 2) MultiKey server_id = 123, client_assigned_perm_id = "foo" 3) MultiKey client_assigned_perm_id = "foo" Multikeys are never serialized in the storage. The individual keys are extracted and processed separately. Both the integer ids as well as string ids are indexed for efficient retrieval using the same fields in the backend. See go/tingle-multikeys for more information on background and motivation. Corresponds to the JSON property lastMatchingItemKey

Returns:



9652
9653
9654
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9652

def last_matching_item_key
  @last_matching_item_key
end

#matching_item_key ⇒ Array<Google::Apis::CloudsearchV1::MultiKey>

If SearchQuery.Options.compute_matching_items_per_thread, this field will contain the keys of all items that matched the query, in ascending order. Note that this option requires extra computation. Corresponds to the JSON property matchingItemKey

Returns:



9659
9660
9661
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9659

def matching_item_key
  @matching_item_key
end

#rank ⇒ Google::Apis::CloudsearchV1::Rank

The rank contains a tuple of numbers which may be used as a general sort order. The rank should be treated as an ordered set of numbers, where the ordering is done in descending order of the most significant rank member. For example, given the following ranks described as (primary, secondary): (1,1), (1,2), (2, 2) (2,1) The descending rank-order is: (2,2) > (2,1) > (1,2) > (1,1) Corresponds to the JSON property rank

Returns:



9668
9669
9670
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9668

def rank
  @rank
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9675
9676
9677
9678
9679
9680
9681
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9675

def update!(**args)
  @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
  @last_matching_item_id = args[:last_matching_item_id] if args.key?(:last_matching_item_id)
  @last_matching_item_key = args[:last_matching_item_key] if args.key?(:last_matching_item_key)
  @matching_item_key = args[:matching_item_key] if args.key?(:matching_item_key)
  @rank = args[:rank] if args.key?(:rank)
end