Class: Google::Apis::CloudsearchV1::MultiKey

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::MultiKey

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

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.

Instance Attribute Summary

• #client_assigned_perm_id ⇒ String

  A client-assigned string based key.

• #server_id ⇒ Fixnum

  A server-assigned ID.

Instance Method Summary

• #initialize(**args) ⇒ MultiKey constructor

  A new instance of MultiKey.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ MultiKey

Returns a new instance of MultiKey.

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14585

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

Instance Attribute Details

#client_assigned_perm_id ⇒ String

A client-assigned string based key. Corresponds to the JSON property clientAssignedPermId

Returns:

• (String)

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14576

def client_assigned_perm_id
  @client_assigned_perm_id
end

#server_id ⇒ Fixnum

A server-assigned ID. This ID must be used only by Gmail and is constructed using millesecond ts << 20 + randomness. The ID affects the sort order of the index. Corresponds to the JSON property serverId

Returns:

• (Fixnum)

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14583

def server_id
  @server_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 14590

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