Class: Google::Apis::CloudsearchV1::CustomEmoji

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

Proto representation of a custom emoji. May be used in both APIs and in Spanner, but certain fields should be restricted to one or the other. See the per-field documentation for details. NEXT_TAG: 11

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomEmoji

Returns a new instance of CustomEmoji.



342
343
344
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 342

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

Instance Attribute Details

#blob_id ⇒ String

ID for the underlying image data in Blobstore. This field should only be present in Spanner or within the server, but should not be exposed in public APIs. Corresponds to the JSON property blobId

Returns:

  • (String) 


291
292
293
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 291

def blob_id
  @blob_id
end

#create_time_micros ⇒ Fixnum

Time when the Emoji was created, in microseconds. This field may be present in Spanner, within the server, or in public APIs. Corresponds to the JSON property createTimeMicros

Returns:

  • (Fixnum) 


297
298
299
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 297

def create_time_micros
  @create_time_micros
end

#creator_user_id ⇒ Google::Apis::CloudsearchV1::UserId

Primary key for User resource. Corresponds to the JSON property creatorUserId

Returns:



302
303
304
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 302

def creator_user_id
  @creator_user_id
end

#owner_customer_id ⇒ Google::Apis::CloudsearchV1::CustomerId

Represents a GSuite customer ID. Obfuscated with CustomerIdObfuscator. Corresponds to the JSON property ownerCustomerId

Returns:



307
308
309
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 307

def owner_customer_id
  @owner_customer_id
end

#read_token ⇒ String

Opaque token that clients use to construct the URL for accessing the custom emoji’s image data. This field is intended for API consumption, and should * never* be persisted to Spanner. Corresponds to the JSON property readToken

Returns:

  • (String) 


314
315
316
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 314

def read_token
  @read_token
end

#shortcode ⇒ String

User-provided, human-readable ID for the custom emoji. Users are expected to observe this field in the UI instead of the UUID. This shortcode should be unique within an organization, but has no global uniqueness guarantees, unlike the UUID. This field should never be persisted to Spanner. Corresponds to the JSON property shortcode

Returns:

  • (String) 


322
323
324
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 322

def shortcode
  @shortcode
end

#state ⇒ String

Snapshot of the current state of the emoji, which may differ from the source- of-truth in the CustomEmojis table. This field should never be persisted to Spanner. Corresponds to the JSON property state

Returns:

  • (String) 


329
330
331
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 329

def state
  @state
end

#update_time_micros ⇒ Fixnum

Corresponds to the JSON property updateTimeMicros

Returns:

  • (Fixnum) 


334
335
336
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 334

def update_time_micros
  @update_time_micros
end

#uuid ⇒ String

Unique key for a custom emoji resource. Required. This field is always populated. Corresponds to the JSON property uuid

Returns:

  • (String) 


340
341
342
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 340

def uuid
  @uuid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 347

def update!(**args)
  @blob_id = args[:blob_id] if args.key?(:blob_id)
  @create_time_micros = args[:create_time_micros] if args.key?(:create_time_micros)
  @creator_user_id = args[:creator_user_id] if args.key?(:creator_user_id)
  @owner_customer_id = args[:owner_customer_id] if args.key?(:owner_customer_id)
  @read_token = args[:read_token] if args.key?(:read_token)
  @shortcode = args[:shortcode] if args.key?(:shortcode)
  @state = args[:state] if args.key?(:state)
  @update_time_micros = args[:update_time_micros] if args.key?(:update_time_micros)
  @uuid = args[:uuid] if args.key?(:uuid)
end