Class: Google::Apis::JobsV3::CloudTalentSolutionService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::JobsV3::CloudTalentSolutionService
- Defined in:
- generated/google/apis/jobs_v3/service.rb
Overview
Cloud Talent Solution API
Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#batch_delete_jobs(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes a list of Jobs by filter.
-
#complete_project(name, company_name: nil, language_code: nil, language_codes: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::CompleteQueryResponse
Completes the specified prefix with keyword suggestions.
-
#create_client_event(parent, create_client_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ClientEvent
Report events issued when end user interacts with customer's application that uses Cloud Talent Solution.
-
#create_company(parent, create_company_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Creates a new company entity.
-
#create_job(parent, create_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Creates a new job.
-
#delete_project_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes specified company.
-
#delete_project_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes the specified job.
-
#get_project_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Retrieves specified company.
-
#get_project_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
-
#initialize ⇒ CloudTalentSolutionService
constructor
A new instance of CloudTalentSolutionService.
-
#list_project_companies(parent, page_size: nil, page_token: nil, require_open_jobs: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ListCompaniesResponse
Lists all companies associated with the service account.
-
#list_project_jobs(parent, filter: nil, job_view: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ListJobsResponse
Lists jobs by filter.
-
#patch_project_company(name, update_company_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Updates specified company.
-
#patch_project_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Updates specified job.
-
#search_jobs(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest.
-
#search_project_job_for_alert(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ CloudTalentSolutionService
Returns a new instance of CloudTalentSolutionService.
46 47 48 49 |
# File 'generated/google/apis/jobs_v3/service.rb', line 46 def initialize super('https://jobs.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
39 40 41 |
# File 'generated/google/apis/jobs_v3/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
44 45 46 |
# File 'generated/google/apis/jobs_v3/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#batch_delete_jobs(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes a list of Jobs by filter.
381 382 383 384 385 386 387 388 389 390 391 |
# File 'generated/google/apis/jobs_v3/service.rb', line 381 def batch_delete_jobs(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/jobs:batchDelete', ) command.request_representation = Google::Apis::JobsV3::BatchDeleteJobsRequest::Representation command.request_object = batch_delete_jobs_request_object command.response_representation = Google::Apis::JobsV3::Empty::Representation command.response_class = Google::Apis::JobsV3::Empty command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#complete_project(name, company_name: nil, language_code: nil, language_codes: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::CompleteQueryResponse
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'generated/google/apis/jobs_v3/service.rb', line 118 def complete_project(name, company_name: nil, language_code: nil, language_codes: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}:complete', ) command.response_representation = Google::Apis::JobsV3::CompleteQueryResponse::Representation command.response_class = Google::Apis::JobsV3::CompleteQueryResponse command.params['name'] = name unless name.nil? command.query['companyName'] = company_name unless company_name.nil? command.query['languageCode'] = language_code unless language_code.nil? command.query['languageCodes'] = language_codes unless language_codes.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['query'] = query unless query.nil? command.query['scope'] = scope unless scope.nil? command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_client_event(parent, create_client_event_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ClientEvent
Report events issued when end user interacts with customer's application that uses Cloud Talent Solution. You may inspect the created events in self service tools. Learn more about self service tools.
162 163 164 165 166 167 168 169 170 171 172 |
# File 'generated/google/apis/jobs_v3/service.rb', line 162 def create_client_event(parent, create_client_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/clientEvents', ) command.request_representation = Google::Apis::JobsV3::CreateClientEventRequest::Representation command.request_object = create_client_event_request_object command.response_representation = Google::Apis::JobsV3::ClientEvent::Representation command.response_class = Google::Apis::JobsV3::ClientEvent command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_company(parent, create_company_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Creates a new company entity.
197 198 199 200 201 202 203 204 205 206 207 |
# File 'generated/google/apis/jobs_v3/service.rb', line 197 def create_company(parent, create_company_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/companies', ) command.request_representation = Google::Apis::JobsV3::CreateCompanyRequest::Representation command.request_object = create_company_request_object command.response_representation = Google::Apis::JobsV3::Company::Representation command.response_class = Google::Apis::JobsV3::Company command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_job(parent, create_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
418 419 420 421 422 423 424 425 426 427 428 |
# File 'generated/google/apis/jobs_v3/service.rb', line 418 def create_job(parent, create_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/jobs', ) command.request_representation = Google::Apis::JobsV3::CreateJobRequest::Representation command.request_object = create_job_request_object command.response_representation = Google::Apis::JobsV3::Job::Representation command.response_class = Google::Apis::JobsV3::Job command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes specified company. Prerequisite: The company has no jobs associated with it.
232 233 234 235 236 237 238 239 240 |
# File 'generated/google/apis/jobs_v3/service.rb', line 232 def delete_project_company(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) command.response_representation = Google::Apis::JobsV3::Empty::Representation command.response_class = Google::Apis::JobsV3::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Empty
Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
454 455 456 457 458 459 460 461 462 |
# File 'generated/google/apis/jobs_v3/service.rb', line 454 def delete_project_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v3/{+name}', ) command.response_representation = Google::Apis::JobsV3::Empty::Representation command.response_class = Google::Apis::JobsV3::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Retrieves specified company.
264 265 266 267 268 269 270 271 272 |
# File 'generated/google/apis/jobs_v3/service.rb', line 264 def get_project_company(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) command.response_representation = Google::Apis::JobsV3::Company::Representation command.response_class = Google::Apis::JobsV3::Company command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
487 488 489 490 491 492 493 494 495 |
# File 'generated/google/apis/jobs_v3/service.rb', line 487 def get_project_job(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+name}', ) command.response_representation = Google::Apis::JobsV3::Job::Representation command.response_class = Google::Apis::JobsV3::Job command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_companies(parent, page_size: nil, page_token: nil, require_open_jobs: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ListCompaniesResponse
Lists all companies associated with the service account.
306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'generated/google/apis/jobs_v3/service.rb', line 306 def list_project_companies(parent, page_size: nil, page_token: nil, require_open_jobs: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/companies', ) command.response_representation = Google::Apis::JobsV3::ListCompaniesResponse::Representation command.response_class = Google::Apis::JobsV3::ListCompaniesResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['requireOpenJobs'] = require_open_jobs unless require_open_jobs.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_jobs(parent, filter: nil, job_view: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::ListJobsResponse
Lists jobs by filter.
540 541 542 543 544 545 546 547 548 549 550 551 552 |
# File 'generated/google/apis/jobs_v3/service.rb', line 540 def list_project_jobs(parent, filter: nil, job_view: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v3/{+parent}/jobs', ) command.response_representation = Google::Apis::JobsV3::ListJobsResponse::Representation command.response_class = Google::Apis::JobsV3::ListJobsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['jobView'] = job_view unless job_view.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_company(name, update_company_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Company
Updates specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.
346 347 348 349 350 351 352 353 354 355 356 |
# File 'generated/google/apis/jobs_v3/service.rb', line 346 def patch_project_company(name, update_company_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v3/{+name}', ) command.request_representation = Google::Apis::JobsV3::UpdateCompanyRequest::Representation command.request_object = update_company_request_object command.response_representation = Google::Apis::JobsV3::Company::Representation command.response_class = Google::Apis::JobsV3::Company command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::Job
Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
583 584 585 586 587 588 589 590 591 592 593 |
# File 'generated/google/apis/jobs_v3/service.rb', line 583 def patch_project_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v3/{+name}', ) command.request_representation = Google::Apis::JobsV3::UpdateJobRequest::Representation command.request_object = update_job_request_object command.response_representation = Google::Apis::JobsV3::Job::Representation command.response_class = Google::Apis::JobsV3::Job command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_jobs(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.
621 622 623 624 625 626 627 628 629 630 631 |
# File 'generated/google/apis/jobs_v3/service.rb', line 621 def search_jobs(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/jobs:search', ) command.request_representation = Google::Apis::JobsV3::SearchJobsRequest::Representation command.request_object = search_jobs_request_object command.response_representation = Google::Apis::JobsV3::SearchJobsResponse::Representation command.response_class = Google::Apis::JobsV3::SearchJobsResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_project_job_for_alert(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3::SearchJobsResponse
Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.
663 664 665 666 667 668 669 670 671 672 673 |
# File 'generated/google/apis/jobs_v3/service.rb', line 663 def search_project_job_for_alert(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v3/{+parent}/jobs:searchForAlert', ) command.request_representation = Google::Apis::JobsV3::SearchJobsRequest::Representation command.request_object = search_jobs_request_object command.response_representation = Google::Apis::JobsV3::SearchJobsResponse::Representation command.response_class = Google::Apis::JobsV3::SearchJobsResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |