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.



20829
20830
20831
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20829

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) 


20753
20754
20755
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20753

def avatar_url
  @avatar_url
end

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

User-block relationship Corresponds to the JSON property blockRelationship

Returns:



20758
20759
20760
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20758

def block_relationship
  @block_relationship
end

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

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

Returns:



20763
20764
20765
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20763

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) 


20769
20770
20771
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20769

def deleted
  @deleted
end

#email ⇒ String

Email ID of the user Corresponds to the JSON property email

Returns:

  • (String) 


20775
20776
20777
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20775

def email
  @email
end

#first_name ⇒ String

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

Returns:

  • (String) 


20780
20781
20782
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20780

def first_name
  @first_name
end

#gender ⇒ String

Gender of the user Corresponds to the JSON property gender

Returns:

  • (String) 


20785
20786
20787
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20785

def gender
  @gender
end

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

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

Returns:



20790
20791
20792
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20790

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) 


20796
20797
20798
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20796

def is_anonymous
  @is_anonymous
end

#last_name ⇒ String

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

Returns:

  • (String) 


20802
20803
20804
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20802

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) 


20807
20808
20809
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20807

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:



20812
20813
20814
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20812

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:



20817
20818
20819
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20817

def phone_number
  @phone_number
end

#user_account_state ⇒ String

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

Returns:

  • (String) 


20822
20823
20824
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20822

def 
  @user_account_state
end

#user_profile_visibility ⇒ String

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

Returns:

  • (String) 


20827
20828
20829
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20827

def 
  @user_profile_visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20834

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