Class: Google::Apis::CloudsearchV1::UserId

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

Primary key for User resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserId

Returns a new instance of UserId.



5780
5781
5782
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5780

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

Instance Attribute Details

#id ⇒ String

Opaque, server-assigned ID of the User. Corresponds to the JSON property id

Returns:

  • (String) 


5765
5766
5767
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5765

def id
  @id
end

#origin_app_id ⇒ Google::Apis::CloudsearchV1::AppId

Identifier of an App. Corresponds to the JSON property originAppId

Returns:



5770
5771
5772
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5770

def origin_app_id
  @origin_app_id
end

#type ⇒ String

Clients do not need to send UserType to Backend, but Backend will always send this field to clients per the following rule: 1. For HUMAN Ids, the field is empty but by default .getType() will return HUMAN. 2. For BOT Ids, the field is ALWAYS set to BOT. Corresponds to the JSON property type

Returns:

  • (String) 


5778
5779
5780
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5778

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5785
5786
5787
5788
5789
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5785

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @origin_app_id = args[:origin_app_id] if args.key?(:origin_app_id)
  @type = args[:type] if args.key?(:type)
end