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.



5873
5874
5875
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5873

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) 


5858
5859
5860
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5858

def id
  @id
end

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

Identifier of an App. Corresponds to the JSON property originAppId

Returns:



5863
5864
5865
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5863

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) 


5871
5872
5873
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5871

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5878
5879
5880
5881
5882
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5878

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