lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb in google-cloud-talent-0.5.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb in google-cloud-talent-0.6.0
- old
+ new
@@ -22,11 +22,11 @@
# 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.
# @!attribute [rw] request_id
# @return [String]
- # Optional but highly recommended.
+ # Strongly recommended for the best service experience.
#
# A unique ID generated in the API responses. It can be found in
# {Google::Cloud::Talent::V4beta1::ResponseMetadata#request_id ResponseMetadata#request_id}.
# @!attribute [rw] event_id
# @return [String]
@@ -42,12 +42,12 @@
# @return [Google::Cloud::Talent::V4beta1::ProfileEvent]
# An event issued when a profile searcher interacts with the application
# that implements Cloud Talent Solution.
# @!attribute [rw] event_notes
# @return [String]
- # Optional. Notes about the event provided by recruiters or other users, for
- # example, feedback on why a profile was bookmarked.
+ # Notes about the event provided by recruiters or other users, for example,
+ # feedback on why a profile was bookmarked.
class ClientEvent; end
# An event issued when a job seeker interacts with the application that
# implements Cloud Talent Solution.
# @!attribute [rw] type
@@ -64,19 +64,19 @@
# {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW view} event, this
# field contains the identifier of the viewed job.
#
# The format is
# "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
+ # example, "projects/foo/tenants/bar/jobs/baz".
# @!attribute [rw] profile
# @return [String]
- # Optional. The {Google::Cloud::Talent::V4beta1::Profile#name profile name}
- # associated with this client event.
+ # The {Google::Cloud::Talent::V4beta1::Profile#name profile name} associated
+ # with this client event.
#
# The format is
# "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
+ # for example, "projects/foo/tenants/bar/profiles/baz".
class JobEvent
# An enumeration of an event attributed to the behavior of the end user,
# such as a job seeker.
module JobEventType
# The event is unspecified by other provided values.
@@ -187,19 +187,18 @@
# Required. The {Google::Cloud::Talent::V4beta1::Profile#name profile name(s)}
# associated with this client event.
#
# The format is
# "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
- # for example, "projects/api-test-project/tenants/foo/profiles/bar".
+ # for example, "projects/foo/tenants/bar/profiles/baz".
# @!attribute [rw] jobs
# @return [Array<String>]
- # Optional. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)}
- # associated with this client event. Leave it empty if the event isn't
- # associated with a job.
+ # The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with
+ # this client event. Leave it empty if the event isn't associated with a job.
#
# The format is
# "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
- # example, "projects/api-test-project/tenants/foo/jobs/1234".
+ # example, "projects/foo/tenants/bar/jobs/baz".
class ProfileEvent
# The enum represents types of client events for a candidate profile.
module ProfileEventType
# Default value.
PROFILE_EVENT_TYPE_UNSPECIFIED = 0
\ No newline at end of file