Class: Google::Apis::CloudsearchV1::Id

Inherits:

Object

• Object
• Google::Apis::CloudsearchV1::Id

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

Identifies a particular object, including both Users and DirEntries. This Id is unique across the entire server instance, such as the production or qa instance.

Instance Attribute Summary

• #creator_user_id ⇒ Fixnum

  The User account in which the DirEntry was originally created.

• #local_id ⇒ String

  The local identifier for the DirEntry (local to the creator's account).

• #name_space ⇒ Fixnum

  The name space in which this id is unique (typically the application that created it).

Instance Method Summary

• #initialize(**args) ⇒ Id constructor

  A new instance of Id.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Id

Returns a new instance of Id.

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

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

Instance Attribute Details

#creator_user_id ⇒ Fixnum

The User account in which the DirEntry was originally created. If name_space== GAIA, then it's the gaia_id of the user this id is referring to. This field should really be called the "bucket ID", not the creator ID. In some circumstances, such as copying a Google Docs file, a user can create an item in a different user's bucket, so it should not be relied upon for anything other than bucket location. To look up the requesting user who initially created item, use the creator_id DirEntry field instead. Corresponds to the JSON property creatorUserId

Returns:

• (Fixnum)

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

def creator_user_id
  @creator_user_id
end

#local_id ⇒ String

The local identifier for the DirEntry (local to the creator's account). local_id + app_name is guaranteed to be unique within the creator account, but not across all User accounts. The string is case sensitive. Ignore if name_space==GAIA. NB For name_space==COSMO, all local_id's should be defined in google3/java/com/google/storage/cosmo/server/api/SpecialObjectIds.java as they have a special predefined meaning. See cosmo.client.CosmoIdFactory. createObjectId(long,String) for IMPORTANT recommendations when generating IDs. Corresponds to the JSON property localId

Returns:

• (String)

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

def local_id
  @local_id
end

#name_space ⇒ Fixnum

The name space in which this id is unique (typically the application that created it). Values should be drawn from the above enum, but for experimentation, use values greater than 1000. Corresponds to the JSON property nameSpace

Returns:

• (Fixnum)

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

def name_space
  @name_space
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

def update!(**args)
  @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id)
  @local_id = args[:local_id] if args.key?(:local_id)
  @name_space = args[:name_space] if args.key?(:name_space)
end