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.



5991
5992
5993
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5991

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

Instance Attribute Details

#acting_user_id ⇒ String

Optional. Opaque, server-assigned ID of the user profile associated with App/ user acting on behalf of the human user. This is currently only set when a 3P application is acting on the user's behalf. Corresponds to the JSON property actingUserId

Returns:

  • (String) 


5971
5972
5973
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5971

def acting_user_id
  @acting_user_id
end

#id ⇒ String

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

Returns:

  • (String) 


5976
5977
5978
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5976

def id
  @id
end

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

Identifier of an App. Corresponds to the JSON property originAppId

Returns:



5981
5982
5983
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5981

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) 


5989
5990
5991
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5989

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5996
5997
5998
5999
6000
6001
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5996

def update!(**args)
  @acting_user_id = args[:acting_user_id] if args.key?(:acting_user_id)
  @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