google-cloud-talent 0.8.1 → 0.20.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -59
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +347 -0
  6. data/README.md +35 -25
  7. data/lib/{google/cloud/talent/v4beta1/doc/google/protobuf/empty.rb → google-cloud-talent.rb} +5 -15
  8. data/lib/google/cloud/talent.rb +254 -442
  9. data/lib/google/cloud/talent/version.rb +6 -2
  10. metadata +62 -111
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/talent/v4beta1.rb +0 -543
  13. data/lib/google/cloud/talent/v4beta1/application_pb.rb +0 -62
  14. data/lib/google/cloud/talent/v4beta1/application_service_client.rb +0 -491
  15. data/lib/google/cloud/talent/v4beta1/application_service_client_config.json +0 -51
  16. data/lib/google/cloud/talent/v4beta1/application_service_pb.rb +0 -54
  17. data/lib/google/cloud/talent/v4beta1/application_service_services_pb.rb +0 -56
  18. data/lib/google/cloud/talent/v4beta1/batch_pb.rb +0 -18
  19. data/lib/google/cloud/talent/v4beta1/common_pb.rb +0 -341
  20. data/lib/google/cloud/talent/v4beta1/company_pb.rb +0 -40
  21. data/lib/google/cloud/talent/v4beta1/company_service_client.rb +0 -535
  22. data/lib/google/cloud/talent/v4beta1/company_service_client_config.json +0 -51
  23. data/lib/google/cloud/talent/v4beta1/company_service_pb.rb +0 -55
  24. data/lib/google/cloud/talent/v4beta1/company_service_services_pb.rb +0 -56
  25. data/lib/google/cloud/talent/v4beta1/completion_client.rb +0 -359
  26. data/lib/google/cloud/talent/v4beta1/completion_client_config.json +0 -31
  27. data/lib/google/cloud/talent/v4beta1/completion_service_pb.rb +0 -55
  28. data/lib/google/cloud/talent/v4beta1/completion_service_services_pb.rb +0 -48
  29. data/lib/google/cloud/talent/v4beta1/credentials.rb +0 -42
  30. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application.rb +0 -166
  31. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/application_service.rb +0 -107
  32. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/common.rb +0 -1147
  33. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company.rb +0 -110
  34. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/company_service.rb +0 -122
  35. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb +0 -141
  36. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event.rb +0 -238
  37. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/event_service.rb +0 -36
  38. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb +0 -847
  39. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/histogram.rb +0 -55
  40. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb +0 -363
  41. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job_service.rb +0 -762
  42. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile.rb +0 -808
  43. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/profile_service.rb +0 -446
  44. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant.rb +0 -74
  45. data/lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/tenant_service.rb +0 -101
  46. data/lib/google/cloud/talent/v4beta1/doc/google/longrunning/operations.rb +0 -51
  47. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/any.rb +0 -131
  48. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/duration.rb +0 -91
  49. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/field_mask.rb +0 -222
  50. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/timestamp.rb +0 -113
  51. data/lib/google/cloud/talent/v4beta1/doc/google/protobuf/wrappers.rb +0 -34
  52. data/lib/google/cloud/talent/v4beta1/doc/google/rpc/status.rb +0 -87
  53. data/lib/google/cloud/talent/v4beta1/doc/google/type/date.rb +0 -43
  54. data/lib/google/cloud/talent/v4beta1/doc/google/type/latlng.rb +0 -31
  55. data/lib/google/cloud/talent/v4beta1/doc/google/type/money.rb +0 -36
  56. data/lib/google/cloud/talent/v4beta1/doc/google/type/postal_address.rb +0 -126
  57. data/lib/google/cloud/talent/v4beta1/doc/google/type/timeofday.rb +0 -37
  58. data/lib/google/cloud/talent/v4beta1/event_pb.rb +0 -69
  59. data/lib/google/cloud/talent/v4beta1/event_service_client.rb +0 -268
  60. data/lib/google/cloud/talent/v4beta1/event_service_client_config.json +0 -31
  61. data/lib/google/cloud/talent/v4beta1/event_service_pb.rb +0 -26
  62. data/lib/google/cloud/talent/v4beta1/event_service_services_pb.rb +0 -53
  63. data/lib/google/cloud/talent/v4beta1/filters_pb.rb +0 -187
  64. data/lib/google/cloud/talent/v4beta1/helpers.rb +0 -162
  65. data/lib/google/cloud/talent/v4beta1/histogram_pb.rb +0 -27
  66. data/lib/google/cloud/talent/v4beta1/job_pb.rb +0 -71
  67. data/lib/google/cloud/talent/v4beta1/job_service_client.rb +0 -1576
  68. data/lib/google/cloud/talent/v4beta1/job_service_client_config.json +0 -76
  69. data/lib/google/cloud/talent/v4beta1/job_service_pb.rb +0 -165
  70. data/lib/google/cloud/talent/v4beta1/job_service_services_pb.rb +0 -92
  71. data/lib/google/cloud/talent/v4beta1/profile_pb.rb +0 -212
  72. data/lib/google/cloud/talent/v4beta1/profile_service_client.rb +0 -844
  73. data/lib/google/cloud/talent/v4beta1/profile_service_client_config.json +0 -56
  74. data/lib/google/cloud/talent/v4beta1/profile_service_pb.rb +0 -88
  75. data/lib/google/cloud/talent/v4beta1/profile_service_services_pb.rb +0 -67
  76. data/lib/google/cloud/talent/v4beta1/tenant_pb.rb +0 -33
  77. data/lib/google/cloud/talent/v4beta1/tenant_service_client.rb +0 -476
  78. data/lib/google/cloud/talent/v4beta1/tenant_service_client_config.json +0 -51
  79. data/lib/google/cloud/talent/v4beta1/tenant_service_pb.rb +0 -54
  80. data/lib/google/cloud/talent/v4beta1/tenant_service_services_pb.rb +0 -55
@@ -1,110 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # A Company resource represents a company in the service. A company is the
21
- # entity that owns job postings, that is, the hiring entity responsible for
22
- # employing applicants for the job position.
23
- # @!attribute [rw] name
24
- # @return [String]
25
- # Required during company update.
26
- #
27
- # The resource name for a company. This is generated by the service when a
28
- # company is created.
29
- #
30
- # The format is
31
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
32
- # example, "projects/foo/tenants/bar/companies/baz".
33
- #
34
- # If tenant id is unspecified, the default tenant is used. For
35
- # example, "projects/foo/companies/bar".
36
- # @!attribute [rw] display_name
37
- # @return [String]
38
- # Required. The display name of the company, for example, "Google LLC".
39
- # @!attribute [rw] external_id
40
- # @return [String]
41
- # Required. Client side company identifier, used to uniquely identify the
42
- # company.
43
- #
44
- # The maximum number of allowed characters is 255.
45
- # @!attribute [rw] size
46
- # @return [Google::Cloud::Talent::V4beta1::CompanySize]
47
- # The employer's company size.
48
- # @!attribute [rw] headquarters_address
49
- # @return [String]
50
- # The street address of the company's main headquarters, which may be
51
- # different from the job location. The service attempts
52
- # to geolocate the provided address, and populates a more specific
53
- # location wherever possible in
54
- # {Google::Cloud::Talent::V4beta1::Company::DerivedInfo#headquarters_location DerivedInfo#headquarters_location}.
55
- # @!attribute [rw] hiring_agency
56
- # @return [true, false]
57
- # Set to true if it is the hiring agency that post jobs for other
58
- # employers.
59
- #
60
- # Defaults to false if not provided.
61
- # @!attribute [rw] eeo_text
62
- # @return [String]
63
- # Equal Employment Opportunity legal disclaimer text to be
64
- # associated with all jobs, and typically to be displayed in all
65
- # roles.
66
- #
67
- # The maximum number of allowed characters is 500.
68
- # @!attribute [rw] website_uri
69
- # @return [String]
70
- # The URI representing the company's primary web site or home page,
71
- # for example, "https://www.google.com".
72
- #
73
- # The maximum number of allowed characters is 255.
74
- # @!attribute [rw] career_site_uri
75
- # @return [String]
76
- # The URI to employer's career site or careers page on the employer's web
77
- # site, for example, "https://careers.google.com".
78
- # @!attribute [rw] image_uri
79
- # @return [String]
80
- # A URI that hosts the employer's company logo.
81
- # @!attribute [rw] keyword_searchable_job_custom_attributes
82
- # @return [Array<String>]
83
- # A list of keys of filterable
84
- # {Google::Cloud::Talent::V4beta1::Job#custom_attributes Job#custom_attributes},
85
- # whose corresponding `string_values` are used in keyword searches. Jobs with
86
- # `string_values` under these specified field keys are returned if any
87
- # of the values match the search keyword. Custom field values with
88
- # parenthesis, brackets and special symbols are not searchable as-is,
89
- # and those keyword queries must be surrounded by quotes.
90
- # @!attribute [rw] derived_info
91
- # @return [Google::Cloud::Talent::V4beta1::Company::DerivedInfo]
92
- # Output only. Derived details about the company.
93
- # @!attribute [rw] suspended
94
- # @return [true, false]
95
- # Output only. Indicates whether a company is flagged to be suspended from
96
- # public availability by the service when job content appears suspicious,
97
- # abusive, or spammy.
98
- class Company
99
- # Derived details about the company.
100
- # @!attribute [rw] headquarters_location
101
- # @return [Google::Cloud::Talent::V4beta1::Location]
102
- # A structured headquarters location of the company, resolved from
103
- # {Google::Cloud::Talent::V4beta1::Company#headquarters_address Company#headquarters_address}
104
- # if provided.
105
- class DerivedInfo; end
106
- end
107
- end
108
- end
109
- end
110
- end
@@ -1,122 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # The Request of the CreateCompany method.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. Resource name of the tenant under which the company is created.
24
- #
25
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant
27
- # is created, for example, "projects/foo".
28
- # @!attribute [rw] company
29
- # @return [Google::Cloud::Talent::V4beta1::Company]
30
- # Required. The company to be created.
31
- class CreateCompanyRequest; end
32
-
33
- # Request for getting a company by name.
34
- # @!attribute [rw] name
35
- # @return [String]
36
- # Required. The resource name of the company to be retrieved.
37
- #
38
- # The format is
39
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
40
- # example, "projects/api-test-project/tenants/foo/companies/bar".
41
- #
42
- # If tenant id is unspecified, the default tenant is used, for
43
- # example, "projects/api-test-project/companies/bar".
44
- class GetCompanyRequest; end
45
-
46
- # Request for updating a specified company.
47
- # @!attribute [rw] company
48
- # @return [Google::Cloud::Talent::V4beta1::Company]
49
- # Required. The company resource to replace the current resource in the
50
- # system.
51
- # @!attribute [rw] update_mask
52
- # @return [Google::Protobuf::FieldMask]
53
- # Strongly recommended for the best service experience.
54
- #
55
- # If
56
- # {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#update_mask update_mask}
57
- # is provided, only the specified fields in
58
- # {Google::Cloud::Talent::V4beta1::UpdateCompanyRequest#company company} are
59
- # updated. Otherwise all the fields are updated.
60
- #
61
- # A field mask to specify the company fields to be updated. Only
62
- # top level fields of {Google::Cloud::Talent::V4beta1::Company Company} are
63
- # supported.
64
- class UpdateCompanyRequest; end
65
-
66
- # Request to delete a company.
67
- # @!attribute [rw] name
68
- # @return [String]
69
- # Required. The resource name of the company to be deleted.
70
- #
71
- # The format is
72
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
73
- # example, "projects/foo/tenants/bar/companies/baz".
74
- #
75
- # If tenant id is unspecified, the default tenant is used, for
76
- # example, "projects/foo/companies/bar".
77
- class DeleteCompanyRequest; end
78
-
79
- # List companies for which the client has ACL visibility.
80
- # @!attribute [rw] parent
81
- # @return [String]
82
- # Required. Resource name of the tenant under which the company is created.
83
- #
84
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
85
- # "projects/foo/tenant/bar".
86
- #
87
- # If tenant id is unspecified, the default tenant will be used, for
88
- # example, "projects/foo".
89
- # @!attribute [rw] page_token
90
- # @return [String]
91
- # The starting indicator from which to return results.
92
- # @!attribute [rw] page_size
93
- # @return [Integer]
94
- # The maximum number of companies to be returned, at most 100.
95
- # Default is 100 if a non-positive number is provided.
96
- # @!attribute [rw] require_open_jobs
97
- # @return [true, false]
98
- # Set to true if the companies requested must have open jobs.
99
- #
100
- # Defaults to false.
101
- #
102
- # If true, at most
103
- # {Google::Cloud::Talent::V4beta1::ListCompaniesRequest#page_size page_size} of
104
- # companies are fetched, among which only those with open jobs are returned.
105
- class ListCompaniesRequest; end
106
-
107
- # The List companies response object.
108
- # @!attribute [rw] companies
109
- # @return [Array<Google::Cloud::Talent::V4beta1::Company>]
110
- # Companies for the current client.
111
- # @!attribute [rw] next_page_token
112
- # @return [String]
113
- # A token to retrieve the next page of results.
114
- # @!attribute [rw] metadata
115
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
116
- # Additional information for the API invocation, such as the request
117
- # tracking id.
118
- class ListCompaniesResponse; end
119
- end
120
- end
121
- end
122
- end
@@ -1,141 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # Auto-complete parameters.
21
- # @!attribute [rw] parent
22
- # @return [String]
23
- # Required. Resource name of tenant the completion is performed within.
24
- #
25
- # The format is "projects/{project_id}/tenants/{tenant_id}", for example,
26
- # "projects/foo/tenant/bar".
27
- #
28
- # If tenant id is unspecified, the default tenant is used, for
29
- # example, "projects/foo".
30
- # @!attribute [rw] query
31
- # @return [String]
32
- # Required. The query used to generate suggestions.
33
- #
34
- # The maximum number of allowed characters is 255.
35
- # @!attribute [rw] language_codes
36
- # @return [Array<String>]
37
- # The list of languages of the query. This is
38
- # the BCP-47 language code, such as "en-US" or "sr-Latn".
39
- # For more information, see
40
- # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).
41
- #
42
- # For
43
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::JOB_TITLE CompletionType::JOB_TITLE}
44
- # type, only open jobs with the same
45
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
46
- # are returned.
47
- #
48
- # For
49
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME CompletionType::COMPANY_NAME}
50
- # type, only companies having open jobs with the same
51
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
52
- # are returned.
53
- #
54
- # For
55
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}
56
- # type, only open jobs with the same
57
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
58
- # or companies having open jobs with the same
59
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest#language_codes language_codes}
60
- # are returned.
61
- #
62
- # The maximum number of allowed characters is 255.
63
- # @!attribute [rw] page_size
64
- # @return [Integer]
65
- # Required. Completion result count.
66
- #
67
- # The maximum allowed page size is 10.
68
- # @!attribute [rw] company
69
- # @return [String]
70
- # If provided, restricts completion to specified company.
71
- #
72
- # The format is
73
- # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
74
- # example, "projects/foo/tenants/bar/companies/baz".
75
- #
76
- # If tenant id is unspecified, the default tenant is used, for
77
- # example, "projects/foo".
78
- # @!attribute [rw] scope
79
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope]
80
- # The scope of the completion. The defaults is
81
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope::PUBLIC}.
82
- # @!attribute [rw] type
83
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
84
- # The completion topic. The default is
85
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMBINED CompletionType::COMBINED}.
86
- class CompleteQueryRequest
87
- # Enum to specify the scope of completion.
88
- module CompletionScope
89
- # Default value.
90
- COMPLETION_SCOPE_UNSPECIFIED = 0
91
-
92
- # Suggestions are based only on the data provided by the client.
93
- TENANT = 1
94
-
95
- # Suggestions are based on all jobs data in the system that's visible to
96
- # the client
97
- PUBLIC = 2
98
- end
99
-
100
- # Enum to specify auto-completion topics.
101
- module CompletionType
102
- # Default value.
103
- COMPLETION_TYPE_UNSPECIFIED = 0
104
-
105
- # Only suggest job titles.
106
- JOB_TITLE = 1
107
-
108
- # Only suggest company names.
109
- COMPANY_NAME = 2
110
-
111
- # Suggest both job titles and company names.
112
- COMBINED = 3
113
- end
114
- end
115
-
116
- # Response of auto-complete query.
117
- # @!attribute [rw] completion_results
118
- # @return [Array<Google::Cloud::Talent::V4beta1::CompleteQueryResponse::CompletionResult>]
119
- # Results of the matching job/company candidates.
120
- # @!attribute [rw] metadata
121
- # @return [Google::Cloud::Talent::V4beta1::ResponseMetadata]
122
- # Additional information for the API invocation, such as the request
123
- # tracking id.
124
- class CompleteQueryResponse
125
- # Resource that represents completion results.
126
- # @!attribute [rw] suggestion
127
- # @return [String]
128
- # The suggestion for the query.
129
- # @!attribute [rw] type
130
- # @return [Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType]
131
- # The completion topic.
132
- # @!attribute [rw] image_uri
133
- # @return [String]
134
- # The URI of the company image for
135
- # {Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType::COMPANY_NAME COMPANY_NAME}.
136
- class CompletionResult; end
137
- end
138
- end
139
- end
140
- end
141
- end
@@ -1,238 +0,0 @@
1
- # Copyright 2019 Google LLC
2
- #
3
- # Licensed under the Apache License, Version 2.0 (the "License");
4
- # you may not use this file except in compliance with the License.
5
- # You may obtain a copy of the License at
6
- #
7
- # https://www.apache.org/licenses/LICENSE-2.0
8
- #
9
- # Unless required by applicable law or agreed to in writing, software
10
- # distributed under the License is distributed on an "AS IS" BASIS,
11
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- # See the License for the specific language governing permissions and
13
- # limitations under the License.
14
-
15
-
16
- module Google
17
- module Cloud
18
- module Talent
19
- module V4beta1
20
- # An event issued when an end user interacts with the application that
21
- # implements Cloud Talent Solution. Providing this information improves the
22
- # quality of results for the API clients, enabling the
23
- # service to perform optimally. The number of events sent must be consistent
24
- # with other calls, such as job searches, issued to the service by the client.
25
- # @!attribute [rw] request_id
26
- # @return [String]
27
- # Strongly recommended for the best service experience.
28
- #
29
- # A unique ID generated in the API responses. It can be found in
30
- # {Google::Cloud::Talent::V4beta1::ResponseMetadata#request_id ResponseMetadata#request_id}.
31
- # @!attribute [rw] event_id
32
- # @return [String]
33
- # Required. A unique identifier, generated by the client application.
34
- # @!attribute [rw] create_time
35
- # @return [Google::Protobuf::Timestamp]
36
- # Required. The timestamp of the event.
37
- # @!attribute [rw] job_event
38
- # @return [Google::Cloud::Talent::V4beta1::JobEvent]
39
- # An event issued when a job seeker interacts with the application that
40
- # implements Cloud Talent Solution.
41
- # @!attribute [rw] profile_event
42
- # @return [Google::Cloud::Talent::V4beta1::ProfileEvent]
43
- # An event issued when a profile searcher interacts with the application
44
- # that implements Cloud Talent Solution.
45
- # @!attribute [rw] event_notes
46
- # @return [String]
47
- # Notes about the event provided by recruiters or other users, for example,
48
- # feedback on why a profile was bookmarked.
49
- class ClientEvent; end
50
-
51
- # An event issued when a job seeker interacts with the application that
52
- # implements Cloud Talent Solution.
53
- # @!attribute [rw] type
54
- # @return [Google::Cloud::Talent::V4beta1::JobEvent::JobEventType]
55
- # Required. The type of the event (see
56
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType JobEventType}).
57
- # @!attribute [rw] jobs
58
- # @return [Array<String>]
59
- # Required. The {Google::Cloud::Talent::V4beta1::Job#name job name(s)}
60
- # associated with this event. For example, if this is an
61
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression}
62
- # event, this field contains the identifiers of all jobs shown to the job
63
- # seeker. If this was a
64
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW view} event, this
65
- # field contains the identifier of the viewed job.
66
- #
67
- # The format is
68
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
69
- # example, "projects/foo/tenants/bar/jobs/baz".
70
- # @!attribute [rw] profile
71
- # @return [String]
72
- # The {Google::Cloud::Talent::V4beta1::Profile#name profile name} associated
73
- # with this client event.
74
- #
75
- # The format is
76
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
77
- # for example, "projects/foo/tenants/bar/profiles/baz".
78
- class JobEvent
79
- # An enumeration of an event attributed to the behavior of the end user,
80
- # such as a job seeker.
81
- module JobEventType
82
- # The event is unspecified by other provided values.
83
- JOB_EVENT_TYPE_UNSPECIFIED = 0
84
-
85
- # The job seeker or other entity interacting with the service has
86
- # had a job rendered in their view, such as in a list of search results in
87
- # a compressed or clipped format. This event is typically associated with
88
- # the viewing of a jobs list on a single page by a job seeker.
89
- IMPRESSION = 1
90
-
91
- # The job seeker, or other entity interacting with the service, has
92
- # viewed the details of a job, including the full description. This
93
- # event doesn't apply to the viewing a snippet of a job appearing as a
94
- # part of the job search results. Viewing a snippet is associated with an
95
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::IMPRESSION impression}).
96
- VIEW = 2
97
-
98
- # The job seeker or other entity interacting with the service
99
- # performed an action to view a job and was redirected to a different
100
- # website for job.
101
- VIEW_REDIRECT = 3
102
-
103
- # The job seeker or other entity interacting with the service
104
- # began the process or demonstrated the intention of applying for a job.
105
- APPLICATION_START = 4
106
-
107
- # The job seeker or other entity interacting with the service
108
- # submitted an application for a job.
109
- APPLICATION_FINISH = 5
110
-
111
- # The job seeker or other entity interacting with the service
112
- # submitted an application for a job with a single click without
113
- # entering information. If a job seeker performs this action, send only
114
- # this event to the service. Do not also send
115
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START}
116
- # or
117
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH}
118
- # events.
119
- APPLICATION_QUICK_SUBMISSION = 6
120
-
121
- # The job seeker or other entity interacting with the service
122
- # performed an action to apply to a job and was redirected to a different
123
- # website to complete the application.
124
- APPLICATION_REDIRECT = 7
125
-
126
- # The job seeker or other entity interacting with the service began the
127
- # process or demonstrated the intention of applying for a job from the
128
- # search results page without viewing the details of the job posting.
129
- # If sending this event, JobEventType.VIEW event shouldn't be sent.
130
- APPLICATION_START_FROM_SEARCH = 8
131
-
132
- # The job seeker, or other entity interacting with the service, performs an
133
- # action with a single click from the search results page to apply to a job
134
- # (without viewing the details of the job posting), and is redirected
135
- # to a different website to complete the application. If a candidate
136
- # performs this action, send only this event to the service. Do not also
137
- # send
138
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_START JobEventType::APPLICATION_START},
139
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::APPLICATION_FINISH JobEventType::APPLICATION_FINISH}
140
- # or
141
- # {Google::Cloud::Talent::V4beta1::JobEvent::JobEventType::VIEW JobEventType::VIEW}
142
- # events.
143
- APPLICATION_REDIRECT_FROM_SEARCH = 9
144
-
145
- # This event should be used when a company submits an application
146
- # on behalf of a job seeker. This event is intended for use by staffing
147
- # agencies attempting to place candidates.
148
- APPLICATION_COMPANY_SUBMIT = 10
149
-
150
- # The job seeker or other entity interacting with the service demonstrated
151
- # an interest in a job by bookmarking or saving it.
152
- BOOKMARK = 11
153
-
154
- # The job seeker or other entity interacting with the service was
155
- # sent a notification, such as an email alert or device notification,
156
- # containing one or more jobs listings generated by the service.
157
- NOTIFICATION = 12
158
-
159
- # The job seeker or other entity interacting with the service was
160
- # employed by the hiring entity (employer). Send this event
161
- # only if the job seeker was hired through an application that was
162
- # initiated by a search conducted through the Cloud Talent Solution
163
- # service.
164
- HIRED = 13
165
-
166
- # A recruiter or staffing agency submitted an application on behalf of the
167
- # candidate after interacting with the service to identify a suitable job
168
- # posting.
169
- SENT_CV = 14
170
-
171
- # The entity interacting with the service (for example, the job seeker),
172
- # was granted an initial interview by the hiring entity (employer). This
173
- # event should only be sent if the job seeker was granted an interview as
174
- # part of an application that was initiated by a search conducted through /
175
- # recommendation provided by the Cloud Talent Solution service.
176
- INTERVIEW_GRANTED = 15
177
- end
178
- end
179
-
180
- # An event issued when a profile searcher interacts with the application
181
- # that implements Cloud Talent Solution.
182
- # @!attribute [rw] type
183
- # @return [Google::Cloud::Talent::V4beta1::ProfileEvent::ProfileEventType]
184
- # Required. Type of event.
185
- # @!attribute [rw] profiles
186
- # @return [Array<String>]
187
- # Required. The {Google::Cloud::Talent::V4beta1::Profile#name profile name(s)}
188
- # associated with this client event.
189
- #
190
- # The format is
191
- # "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}",
192
- # for example, "projects/foo/tenants/bar/profiles/baz".
193
- # @!attribute [rw] jobs
194
- # @return [Array<String>]
195
- # The {Google::Cloud::Talent::V4beta1::Job#name job name(s)} associated with
196
- # this client event. Leave it empty if the event isn't associated with a job.
197
- #
198
- # The format is
199
- # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
200
- # example, "projects/foo/tenants/bar/jobs/baz".
201
- class ProfileEvent
202
- # The enum represents types of client events for a candidate profile.
203
- module ProfileEventType
204
- # Default value.
205
- PROFILE_EVENT_TYPE_UNSPECIFIED = 0
206
-
207
- # Send this event when a
208
- # {Google::Cloud::Talent::V4beta1::ProfileEvent#profiles ProfileEvent#profiles}
209
- # was sent as a part of a result set for a CTS API call and was rendered in
210
- # the end user's UI (that is, the
211
- # {Google::Cloud::Talent::V4beta1::ProfileEvent#recruiter ProfileEvent#recruiter}).
212
- IMPRESSION = 1
213
-
214
- # The VIEW event records the action of a candidate's profile being
215
- # viewed by an end user. This is critical to tracking product metrics and
216
- # should be sent for every profile VIEW that happens in your system,
217
- # whether the event is associated with an API call (for example, a
218
- # recruiter making a request for a result set and clicking on a profile)
219
- # or not (a recruiter using the system to view profile details without
220
- # making a request).
221
- #
222
- # For a VIEW events associated with API calls, the
223
- # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id ClientEvent#request_id}
224
- # should be populated. If the VIEW is not associated with an API call,
225
- # {Google::Cloud::Talent::V4beta1::ClientEvent#request_id request_id} should
226
- # not be populated.
227
- #
228
- # This event requires a valid recruiter and one valid ID in profiles.
229
- VIEW = 2
230
-
231
- # The profile is bookmarked.
232
- BOOKMARK = 3
233
- end
234
- end
235
- end
236
- end
237
- end
238
- end