Class: Google::Apis::JobsV4::ClientEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v4/classes.rb,
generated/google/apis/jobs_v4/representations.rb,
generated/google/apis/jobs_v4/representations.rb

Overview

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ClientEvent

Returns a new instance of ClientEvent.



299
300
301
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 299

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

Instance Attribute Details

#create_time ⇒ String

Required. The timestamp of the event. Corresponds to the JSON property createTime

Returns:

  • (String) 


274
275
276
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 274

def create_time
  @create_time
end

#event_id ⇒ String

Required. A unique identifier, generated by the client application. Corresponds to the JSON property eventId

Returns:

  • (String) 


279
280
281
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 279

def event_id
  @event_id
end

#event_notes ⇒ String

Notes about the event provided by recruiters or other users, for example, feedback on why a job was bookmarked. Corresponds to the JSON property eventNotes

Returns:

  • (String) 


285
286
287
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 285

def event_notes
  @event_notes
end

#job_event ⇒ Google::Apis::JobsV4::JobEvent

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution. Corresponds to the JSON property jobEvent

Returns:



291
292
293
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 291

def job_event
  @job_event
end

#request_id ⇒ String

Strongly recommended for the best service experience. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. Corresponds to the JSON property requestId

Returns:

  • (String) 


297
298
299
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 297

def request_id
  @request_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



304
305
306
307
308
309
310
 
# File 'generated/google/apis/jobs_v4/classes.rb', line 304

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @event_id = args[:event_id] if args.key?(:event_id)
  @event_notes = args[:event_notes] if args.key?(:event_notes)
  @job_event = args[:job_event] if args.key?(:job_event)
  @request_id = args[:request_id] if args.key?(:request_id)
end