Class: Google::Apis::CloudsupportV2beta::Actor

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsupport_v2beta/classes.rb,
lib/google/apis/cloudsupport_v2beta/representations.rb,
lib/google/apis/cloudsupport_v2beta/representations.rb

Overview

An object containing information about the effective user and authenticated principal responsible for an action.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Actor

Returns a new instance of Actor.



61
62
63
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 61

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

Instance Attribute Details

#display_name ⇒ String

The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. Corresponds to the JSON property displayName

Returns:

  • (String) 


36
37
38
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 36

def display_name
  @display_name
end

#email ⇒ String

The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent. Corresponds to the JSON property email

Returns:

  • (String) 


45
46
47
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 45

def email
  @email
end

#google_support ⇒ Boolean Also known as: google_support?

Output only. Whether the actor is a Google support actor. Corresponds to the JSON property googleSupport

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 50

def google_support
  @google_support
end

#principal_id ⇒ String

Output only. An ID representing the user that was authenticated when the corresponding action was taken. This will be an email address, if one is available, or some other unique ID. See https://cloud.google.com/docs/ authentication for more information on types of authentication. Corresponds to the JSON property principalId

Returns:

  • (String) 


59
60
61
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 59

def principal_id
  @principal_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



66
67
68
69
70
71
 
# File 'lib/google/apis/cloudsupport_v2beta/classes.rb', line 66

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @google_support = args[:google_support] if args.key?(:google_support)
  @principal_id = args[:principal_id] if args.key?(:principal_id)
end