Class: Google::Apis::JobsV2::CloudTalentSolutionService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/jobs_v2/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.

Examples:

require 'google/apis/jobs_v2'

Jobs = Google::Apis::JobsV2 # Alias the module
service = Jobs::CloudTalentSolutionService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudTalentSolutionService


46
47
48
49
# File 'generated/google/apis/jobs_v2/service.rb', line 46

def initialize
  super('https://jobs.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/jobs_v2/service.rb', line 39

def key
  @key
end

#quota_userString


44
45
46
# File 'generated/google/apis/jobs_v2/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#batch_delete_jobs(batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Empty

Deletes a list of Job postings by filter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


321
322
323
324
325
326
327
328
329
330
# File 'generated/google/apis/jobs_v2/service.rb', line 321

def batch_delete_jobs(batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs:batchDelete', options)
  command.request_representation = Google::Apis::JobsV2::BatchDeleteJobsRequest::Representation
  command.request_object = batch_delete_jobs_request_object
  command.response_representation = Google::Apis::JobsV2::Empty::Representation
  command.response_class = Google::Apis::JobsV2::Empty
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#complete(company_name: nil, language_code: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::CompleteQueryResponse

Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


710
711
712
713
714
715
716
717
718
719
720
721
722
723
# File 'generated/google/apis/jobs_v2/service.rb', line 710

def complete(company_name: nil, language_code: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2:complete', options)
  command.response_representation = Google::Apis::JobsV2::CompleteQueryResponse::Representation
  command.response_class = Google::Apis::JobsV2::CompleteQueryResponse
  command.query['companyName'] = company_name unless company_name.nil?
  command.query['languageCode'] = language_code unless language_code.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(company_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Company

Creates a new company entity.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


70
71
72
73
74
75
76
77
78
79
# File 'generated/google/apis/jobs_v2/service.rb', line 70

def create_company(company_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/companies', options)
  command.request_representation = Google::Apis::JobsV2::Company::Representation
  command.request_object = company_object
  command.response_representation = Google::Apis::JobsV2::Company::Representation
  command.response_class = Google::Apis::JobsV2::Company
  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(create_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Job

Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


353
354
355
356
357
358
359
360
361
362
# File 'generated/google/apis/jobs_v2/service.rb', line 353

def create_job(create_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs', options)
  command.request_representation = Google::Apis::JobsV2::CreateJobRequest::Representation
  command.request_object = create_job_request_object
  command.response_representation = Google::Apis::JobsV2::Job::Representation
  command.response_class = Google::Apis::JobsV2::Job
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Empty

Deletes the specified company.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


102
103
104
105
106
107
108
109
110
# File 'generated/google/apis/jobs_v2/service.rb', line 102

def delete_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::JobsV2::Empty::Representation
  command.response_class = Google::Apis::JobsV2::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_job(name, disable_fast_process: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Empty

Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


392
393
394
395
396
397
398
399
400
401
# File 'generated/google/apis/jobs_v2/service.rb', line 392

def delete_job(name, disable_fast_process: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::JobsV2::Empty::Representation
  command.response_class = Google::Apis::JobsV2::Empty
  command.params['name'] = name unless name.nil?
  command.query['disableFastProcess'] = disable_fast_process unless disable_fast_process.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_job_by_filter(delete_jobs_by_filter_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Empty

Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


425
426
427
428
429
430
431
432
433
434
# File 'generated/google/apis/jobs_v2/service.rb', line 425

def delete_job_by_filter(delete_jobs_by_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs:deleteByFilter', options)
  command.request_representation = Google::Apis::JobsV2::DeleteJobsByFilterRequest::Representation
  command.request_object = delete_jobs_by_filter_request_object
  command.response_representation = Google::Apis::JobsV2::Empty::Representation
  command.response_class = Google::Apis::JobsV2::Empty
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Company

Retrieves the specified company.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


133
134
135
136
137
138
139
140
141
# File 'generated/google/apis/jobs_v2/service.rb', line 133

def get_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::JobsV2::Company::Representation
  command.response_class = Google::Apis::JobsV2::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_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Job

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


457
458
459
460
461
462
463
464
465
# File 'generated/google/apis/jobs_v2/service.rb', line 457

def get_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::JobsV2::Job::Representation
  command.response_class = Google::Apis::JobsV2::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

#histogram_job(get_histogram_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::GetHistogramResponse

Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


496
497
498
499
500
501
502
503
504
505
# File 'generated/google/apis/jobs_v2/service.rb', line 496

def histogram_job(get_histogram_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs:histogram', options)
  command.request_representation = Google::Apis::JobsV2::GetHistogramRequest::Representation
  command.request_object = get_histogram_request_object
  command.response_representation = Google::Apis::JobsV2::GetHistogramResponse::Representation
  command.response_class = Google::Apis::JobsV2::GetHistogramResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_companies(must_have_open_jobs: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::ListCompaniesResponse

Lists all companies associated with a Cloud Talent Solution account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


171
172
173
174
175
176
177
178
179
180
181
# File 'generated/google/apis/jobs_v2/service.rb', line 171

def list_companies(must_have_open_jobs: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/companies', options)
  command.response_representation = Google::Apis::JobsV2::ListCompaniesResponse::Representation
  command.response_class = Google::Apis::JobsV2::ListCompaniesResponse
  command.query['mustHaveOpenJobs'] = must_have_open_jobs unless must_have_open_jobs.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

#list_company_jobs(company_name, ids_only: nil, include_jobs_count: nil, job_requisition_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::ListCompanyJobsResponse

Deprecated. Use ListJobs instead. Lists all jobs associated with a company.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'generated/google/apis/jobs_v2/service.rb', line 287

def list_company_jobs(company_name, ids_only: nil, include_jobs_count: nil, job_requisition_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/{+companyName}/jobs', options)
  command.response_representation = Google::Apis::JobsV2::ListCompanyJobsResponse::Representation
  command.response_class = Google::Apis::JobsV2::ListCompanyJobsResponse
  command.params['companyName'] = company_name unless company_name.nil?
  command.query['idsOnly'] = ids_only unless ids_only.nil?
  command.query['includeJobsCount'] = include_jobs_count unless include_jobs_count.nil?
  command.query['jobRequisitionId'] = job_requisition_id unless job_requisition_id.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

#list_jobs(filter: nil, ids_only: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::ListJobsResponse

Lists jobs by filter.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


546
547
548
549
550
551
552
553
554
555
556
557
# File 'generated/google/apis/jobs_v2/service.rb', line 546

def list_jobs(filter: nil, ids_only: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2/jobs', options)
  command.response_representation = Google::Apis::JobsV2::ListJobsResponse::Representation
  command.response_class = Google::Apis::JobsV2::ListJobsResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['idsOnly'] = ids_only unless ids_only.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_company(name, company_object = nil, update_company_fields: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Company

Updates the 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


228
229
230
231
232
233
234
235
236
237
238
239
# File 'generated/google/apis/jobs_v2/service.rb', line 228

def patch_company(name, company_object = nil, update_company_fields: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::JobsV2::Company::Representation
  command.request_object = company_object
  command.response_representation = Google::Apis::JobsV2::Company::Representation
  command.response_class = Google::Apis::JobsV2::Company
  command.params['name'] = name unless name.nil?
  command.query['updateCompanyFields'] = update_company_fields unless update_company_fields.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_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::Job

Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


585
586
587
588
589
590
591
592
593
594
595
# File 'generated/google/apis/jobs_v2/service.rb', line 585

def patch_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::JobsV2::UpdateJobRequest::Representation
  command.request_object = update_job_request_object
  command.response_representation = Google::Apis::JobsV2::Job::Representation
  command.response_class = Google::Apis::JobsV2::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_job_for_alert(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


656
657
658
659
660
661
662
663
664
665
# File 'generated/google/apis/jobs_v2/service.rb', line 656

def search_job_for_alert(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs:searchForAlert', options)
  command.request_representation = Google::Apis::JobsV2::SearchJobsRequest::Representation
  command.request_object = search_jobs_request_object
  command.response_representation = Google::Apis::JobsV2::SearchJobsResponse::Representation
  command.response_class = Google::Apis::JobsV2::SearchJobsResponse
  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(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV2::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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


619
620
621
622
623
624
625
626
627
628
# File 'generated/google/apis/jobs_v2/service.rb', line 619

def search_jobs(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2/jobs:search', options)
  command.request_representation = Google::Apis::JobsV2::SearchJobsRequest::Representation
  command.request_object = search_jobs_request_object
  command.response_representation = Google::Apis::JobsV2::SearchJobsResponse::Representation
  command.response_class = Google::Apis::JobsV2::SearchJobsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end