Class: Google::Apis::JobsV3::ClientEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/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 search and recommendation 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.



186
187
188
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 186

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) 


148
149
150
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 148

def create_time
  @create_time
end

#event_id ⇒ String

Required. A unique identifier, generated by the client application. This event_id is used to establish the relationship between different events (see parent_event_id). Corresponds to the JSON property eventId

Returns:

  • (String) 


155
156
157
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 155

def event_id
  @event_id
end

#extra_info ⇒ Hash<String,String>

Optional. Extra information about this event. Used for storing information with no matching field in event payload, for example, user application specific context or details. At most 20 keys are supported. The maximum total size of all keys and values is 2 KB. Corresponds to the JSON property extraInfo

Returns:

  • (Hash<String,String>) 


163
164
165
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 163

def extra_info
  @extra_info
end

#job_event ⇒ Google::Apis::JobsV3::JobEvent

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

Returns:



169
170
171
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 169

def job_event
  @job_event
end

#parent_event_id ⇒ String

Optional. The event_id of an event that resulted in the current event. For example, a Job view event usually follows a parent impression event: A job seeker first does a search where a list of jobs appears (impression). The job seeker then selects a result and views the description of a particular job ( Job view). Corresponds to the JSON property parentEventId

Returns:

  • (String) 


178
179
180
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 178

def parent_event_id
  @parent_event_id
end

#request_id ⇒ String

Required. A unique ID generated in the API responses. It can be found in ResponseMetadata.request_id. Corresponds to the JSON property requestId

Returns:

  • (String) 


184
185
186
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 184

def request_id
  @request_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



191
192
193
194
195
196
197
198
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 191

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