Class: Google::Apis::CloudsearchV1::UserMentionData

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

Person metadata, for USER_MENTION segments. Should always contain at least one of user_gaia_id, user_id, email or user. The exact set of populated fields may differ depending on the context and the level in the serving stack; for example, emails will be elided on the viewing path. But as a general rule, a proto having any one of the four is valid, subject to the standard constraints of the applied annotations -- that is, communication between servers and clients will ignore jspb.ignore fields, and communication between servers and other servers (or between servers and storage) will ignore client_only fields. For more on the annotations, see the comments in social/common/ segment_annotations.proto

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserMentionData

Returns a new instance of UserMentionData.



17528
17529
17530
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17528

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

Instance Attribute Details

#email ⇒ String

Corresponds to the JSON property email

Returns:

  • (String) 


17505
17506
17507
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17505

def email
  @email
end

#user ⇒ Google::Apis::CloudsearchV1::PrincipalProto

A Principal represents something to which permissions are assigned, often but not always a user or group of some kind. It is most appropriate for use in ACLs and authorization checks. Callers should prefer to use the wrapper classes in google3/security/credentials/public/principal.h google3/java/com/ google/security/credentials/Principal.java google3/security/credentials/go/ principal.go unless direct proto access is essential. If you update this protocol buffer, please update the wrapper classes as well. Corresponds to the JSON property user

Returns:



17516
17517
17518
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17516

def user
  @user
end

#user_gaia_id ⇒ Fixnum

An unobfuscated gaia ID: Corresponds to the JSON property userGaiaId

Returns:

  • (Fixnum) 


17521
17522
17523
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17521

def user_gaia_id
  @user_gaia_id
end

#user_id ⇒ String

An obfuscated gaia ID: Corresponds to the JSON property userId

Returns:

  • (String) 


17526
17527
17528
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17526

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17533
17534
17535
17536
17537
17538
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17533

def update!(**args)
  @email = args[:email] if args.key?(:email)
  @user = args[:user] if args.key?(:user)
  @user_gaia_id = args[:user_gaia_id] if args.key?(:user_gaia_id)
  @user_id = args[:user_id] if args.key?(:user_id)
end