Class: Google::Apis::CloudsearchV1::User

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

User profile information. This user is not necessarily member of a space.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ User

Returns a new instance of User.



20691
20692
20693
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20691

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

Instance Attribute Details

#avatar_url ⇒ String

URL for the avatar picture of the User in dynamite Corresponds to the JSON property avatarUrl

Returns:

  • (String) 


20615
20616
20617
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20615

def avatar_url
  @avatar_url
end

#block_relationship ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedUserBlockRelationship

User-block relationship Corresponds to the JSON property blockRelationship

Returns:



20620
20621
20622
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20620

def block_relationship
  @block_relationship
end

#bot_info ⇒ Google::Apis::CloudsearchV1::BotInfo

Bot-specific profile information. Corresponds to the JSON property botInfo

Returns:



20625
20626
20627
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20625

def bot_info
  @bot_info
end

#deleted ⇒ Boolean Also known as: deleted?

Deleted flag, if true, means User has been soft-deleted/purged Deprecated. Use user_account_state field instead. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


20631
20632
20633
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20631

def deleted
  @deleted
end

#email ⇒ String

Email ID of the user Corresponds to the JSON property email

Returns:

  • (String) 


20637
20638
20639
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20637

def email
  @email
end

#first_name ⇒ String

First or given name of the user Corresponds to the JSON property firstName

Returns:

  • (String) 


20642
20643
20644
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20642

def first_name
  @first_name
end

#gender ⇒ String

Gender of the user Corresponds to the JSON property gender

Returns:

  • (String) 


20647
20648
20649
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20647

def gender
  @gender
end

#id ⇒ Google::Apis::CloudsearchV1::UserId

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

Returns:



20652
20653
20654
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20652

def id
  @id
end

#is_anonymous ⇒ Boolean Also known as: is_anonymous?

Set to true if none of the depending services (Gaia, PeopleApi) returns any info for this user. Corresponds to the JSON property isAnonymous

Returns:

  • (Boolean) 


20658
20659
20660
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20658

def is_anonymous
  @is_anonymous
end

#last_name ⇒ String

Last or family name of the user Corresponds to the JSON property lastName

Returns:

  • (String) 


20664
20665
20666
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20664

def last_name
  @last_name
end

#name ⇒ String

Non-unique, user-defined display name of the User Corresponds to the JSON property name

Returns:

  • (String) 


20669
20670
20671
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20669

def name
  @name
end

#organization_info ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedOrganizationInfo

Contains info about the entity that something is, or is owned by. Corresponds to the JSON property organizationInfo

Returns:



20674
20675
20676
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20674

def organization_info
  @organization_info
end

#phone_number ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteSharedPhoneNumber>

Phone number(s) of the user Corresponds to the JSON property phoneNumber

Returns:



20679
20680
20681
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20679

def phone_number
  @phone_number
end

#user_account_state ⇒ String

State of user's Gaia Account Corresponds to the JSON property userAccountState

Returns:

  • (String) 


20684
20685
20686
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20684

def 
  @user_account_state
end

#user_profile_visibility ⇒ String

Visibility of user's Profile Corresponds to the JSON property userProfileVisibility

Returns:

  • (String) 


20689
20690
20691
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20689

def 
  @user_profile_visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20696

def update!(**args)
  @avatar_url = args[:avatar_url] if args.key?(:avatar_url)
  @block_relationship = args[:block_relationship] if args.key?(:block_relationship)
  @bot_info = args[:bot_info] if args.key?(:bot_info)
  @deleted = args[:deleted] if args.key?(:deleted)
  @email = args[:email] if args.key?(:email)
  @first_name = args[:first_name] if args.key?(:first_name)
  @gender = args[:gender] if args.key?(:gender)
  @id = args[:id] if args.key?(:id)
  @is_anonymous = args[:is_anonymous] if args.key?(:is_anonymous)
  @last_name = args[:last_name] if args.key?(:last_name)
  @name = args[:name] if args.key?(:name)
  @organization_info = args[:organization_info] if args.key?(:organization_info)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @user_account_state = args[:user_account_state] if args.key?(:user_account_state)
  @user_profile_visibility = args[:user_profile_visibility] if args.key?(:user_profile_visibility)
end