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_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.
357 358 359 360 361 362 363 364 365 366 367 |
# File 'generated/google/apis/jobs_v3/service.rb', line 357 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.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'generated/google/apis/jobs_v3/service.rb', line 125 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_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.
166 167 168 169 170 171 172 173 174 175 176 |
# File 'generated/google/apis/jobs_v3/service.rb', line 166 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.
395 396 397 398 399 400 401 402 403 404 405 |
# File 'generated/google/apis/jobs_v3/service.rb', line 395 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.
202 203 204 205 206 207 208 209 210 |
# File 'generated/google/apis/jobs_v3/service.rb', line 202 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.
432 433 434 435 436 437 438 439 440 |
# File 'generated/google/apis/jobs_v3/service.rb', line 432 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.
235 236 237 238 239 240 241 242 243 |
# File 'generated/google/apis/jobs_v3/service.rb', line 235 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.
466 467 468 469 470 471 472 473 474 |
# File 'generated/google/apis/jobs_v3/service.rb', line 466 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.
281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'generated/google/apis/jobs_v3/service.rb', line 281 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.
524 525 526 527 528 529 530 531 532 533 534 535 536 |
# File 'generated/google/apis/jobs_v3/service.rb', line 524 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.
321 322 323 324 325 326 327 328 329 330 331 |
# File 'generated/google/apis/jobs_v3/service.rb', line 321 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.
567 568 569 570 571 572 573 574 575 576 577 |
# File 'generated/google/apis/jobs_v3/service.rb', line 567 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.
606 607 608 609 610 611 612 613 614 615 616 |
# File 'generated/google/apis/jobs_v3/service.rb', line 606 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.
649 650 651 652 653 654 655 656 657 658 659 |
# File 'generated/google/apis/jobs_v3/service.rb', line 649 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 |