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

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

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 collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Id

Returns a new instance of Id.



2134
2135
2136
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2134

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. Corresponds to the JSON property creatorUserId

Returns:

  • (Fixnum) 


2114
2115
2116
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2114

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) 


2125
2126
2127
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2125

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) 


2132
2133
2134
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2132

def name_space
  @name_space
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2139
2140
2141
2142
2143
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2139

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