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.



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

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) 


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

def avatar_url
  @avatar_url
end

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

User-block relationship Corresponds to the JSON property blockRelationship

Returns:



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

def block_relationship
  @block_relationship
end

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

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

Returns:



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

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) 


20694
20695
20696
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20694

def deleted
  @deleted
end

#email ⇒ String

Email ID of the user Corresponds to the JSON property email

Returns:

  • (String) 


20700
20701
20702
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20700

def email
  @email
end

#first_name ⇒ String

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

Returns:

  • (String) 


20705
20706
20707
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20705

def first_name
  @first_name
end

#gender ⇒ String

Gender of the user Corresponds to the JSON property gender

Returns:

  • (String) 


20710
20711
20712
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20710

def gender
  @gender
end

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

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

Returns:



20715
20716
20717
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20715

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) 


20721
20722
20723
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20721

def is_anonymous
  @is_anonymous
end

#last_name ⇒ String

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

Returns:

  • (String) 


20727
20728
20729
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20727

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) 


20732
20733
20734
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20732

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:



20737
20738
20739
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20737

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:



20742
20743
20744
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20742

def phone_number
  @phone_number
end

#user_account_state ⇒ String

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

Returns:

  • (String) 


20747
20748
20749
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20747

def 
  @user_account_state
end

#user_profile_visibility ⇒ String

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

Returns:

  • (String) 


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

def 
  @user_profile_visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20759

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