Class: Google::Apis::CloudsupportV2::Actor

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

Overview

An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case.

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_v2/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) 


37
38
39
 
# File 'lib/google/apis/cloudsupport_v2/classes.rb', line 37

def display_name
  @display_name
end

#email ⇒ String

The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use username field instead. Corresponds to the JSON property email

Returns:

  • (String) 


45
46
47
 
# File 'lib/google/apis/cloudsupport_v2/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_v2/classes.rb', line 50

def google_support
  @google_support
end

#username ⇒ String

Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. Corresponds to the JSON property username

Returns:

  • (String) 


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

def username
  @username
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



66
67
68
69
70
71
 
# File 'lib/google/apis/cloudsupport_v2/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)
  @username = args[:username] if args.key?(:username)
end