Class: Google::Apis::JobsV3p1beta1::CloudTalentSolutionService

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

Jobs = Google::Apis::JobsV3p1beta1 # 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

#initialize ⇒ CloudTalentSolutionService

Returns a new instance of CloudTalentSolutionService



46
47
48
49
 
# File 'generated/google/apis/jobs_v3p1beta1/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.

Returns:

  • (String) —

    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_v3p1beta1/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.

Returns:

  • (String) —

    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_v3p1beta1/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::JobsV3p1beta1::Empty

Deletes a list of Jobs by filter.

Parameters:

  • parent (String) —

    Required. The resource name of the project under which the job is created. The format is "projects/project_id", for example, "projects/api-test-project".

  • batch_delete_jobs_request_object (Google::Apis::JobsV3p1beta1::BatchDeleteJobsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



379
380
381
382
383
384
385
386
387
388
389
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 379

def batch_delete_jobs(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3p1beta1/{+parent}/jobs:batchDelete', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::BatchDeleteJobsRequest::Representation
  command.request_object = batch_delete_jobs_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::Empty::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV3p1beta1::CompleteQueryResponse

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

Parameters:

  • name (String) —

    Required. Resource name of project the completion is performed within. The format is "projects/project_id", for example, "projects/api-test-project".

  • company_name (String) —

    Optional. If provided, restricts completion to specified company. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo".

  • language_code (String) —

    Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255.

  • page_size (Fixnum) —

    Required. Completion result count. The maximum allowed page size is 10.

  • query (String) —

    Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

  • scope (String) —

    Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.

  • type (String) —

    Optional. The completion topic. The default is CompletionType.COMBINED.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 109

def complete_project(name, 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, 'v3p1beta1/{+name}:complete', options)
  command.response_representation = Google::Apis::JobsV3p1beta1::CompleteQueryResponse::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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['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::JobsV3p1beta1::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.

Parameters:

  • parent (String) —

    Parent project name.

  • create_client_event_request_object (Google::Apis::JobsV3p1beta1::CreateClientEventRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



153
154
155
156
157
158
159
160
161
162
163
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 153

def create_client_event(parent, create_client_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3p1beta1/{+parent}/clientEvents', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::CreateClientEventRequest::Representation
  command.request_object = create_client_event_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::ClientEvent::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Company

Creates a new company entity.

Parameters:

  • parent (String) —

    Required. Resource name of the project under which the company is created. The format is "projects/project_id", for example, "projects/api-test-project".

  • create_company_request_object (Google::Apis::JobsV3p1beta1::CreateCompanyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



189
190
191
192
193
194
195
196
197
198
199
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 189

def create_company(parent, create_company_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3p1beta1/{+parent}/companies', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::CreateCompanyRequest::Representation
  command.request_object = create_company_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::Company::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Job

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

Parameters:

  • parent (String) —

    Required. The resource name of the project under which the job is created. The format is "projects/project_id", for example, "projects/api-test-project".

  • create_job_request_object (Google::Apis::JobsV3p1beta1::CreateJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



417
418
419
420
421
422
423
424
425
426
427
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 417

def create_job(parent, create_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3p1beta1/{+parent}/jobs', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::CreateJobRequest::Representation
  command.request_object = create_job_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::Job::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Empty

Deletes specified company.

Parameters:

  • name (String) —

    Required. The resource name of the company to be deleted. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



224
225
226
227
228
229
230
231
232
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 224

def delete_project_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v3p1beta1/{+name}', options)
  command.response_representation = Google::Apis::JobsV3p1beta1::Empty::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Empty

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

Parameters:

  • name (String) —

    Required. The resource name of the job to be deleted. The format is "projects/project_id/jobs/job_id", for example, "projects/api-test-project/jobs/1234".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



454
455
456
457
458
459
460
461
462
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 454

def delete_project_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v3p1beta1/{+name}', options)
  command.response_representation = Google::Apis::JobsV3p1beta1::Empty::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Company

Retrieves specified company.

Parameters:

  • name (String) —

    Required. The resource name of the company to be retrieved. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



257
258
259
260
261
262
263
264
265
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 257

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

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

Parameters:

  • name (String) —

    Required. The resource name of the job to retrieve. The format is "projects/project_id/jobs/job_id", for example, "projects/api-test-project/jobs/1234".

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



488
489
490
491
492
493
494
495
496
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 488

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

Lists all companies associated with the service account.

Parameters:

  • parent (String) —

    Required. Resource name of the project under which the company is created. The format is "projects/project_id", for example, "projects/api-test-project".

  • page_size (Fixnum) —

    Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.

  • page_token (String) —

    Optional. The starting indicator from which to return results.

  • require_open_jobs (Boolean) —

    Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 303

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, 'v3p1beta1/{+parent}/companies', options)
  command.response_representation = Google::Apis::JobsV3p1beta1::ListCompaniesResponse::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::ListJobsResponse

Lists jobs by filter.

Parameters:

  • parent (String) —

    Required. The resource name of the project under which the job is created. The format is "projects/project_id", for example, "projects/api-test-project".

  • filter (String) —

    Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are:

    • companyName (Required)
    • requisitionId (Optional) Sample Query:
    • companyName = "projects/api-test-project/companies/123"
    • companyName = "projects/api-test-project/companies/123" AND requisitionId = "req-1"
  • job_view (String) —

    Optional. The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

  • page_size (Fixnum) —

    Optional. The maximum number of jobs to be returned per page of results. If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.

  • page_token (String) —

    Optional. The starting point of a query result.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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, 'v3p1beta1/{+parent}/jobs', options)
  command.response_representation = Google::Apis::JobsV3p1beta1::ListJobsResponse::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::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.

Parameters:

  • name (String) —

    Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo".

  • update_company_request_object (Google::Apis::JobsV3p1beta1::UpdateCompanyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



343
344
345
346
347
348
349
350
351
352
353
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 343

def patch_project_company(name, update_company_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v3p1beta1/{+name}', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::UpdateCompanyRequest::Representation
  command.request_object = update_company_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::Company::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::Job

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

Parameters:

  • name (String) —

    Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/project_id/jobs/job_id", for example, "projects/api-test-project/jobs/1234". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

  • update_job_request_object (Google::Apis::JobsV3p1beta1::UpdateJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



589
590
591
592
593
594
595
596
597
598
599
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 589

def patch_project_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v3p1beta1/{+name}', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::UpdateJobRequest::Representation
  command.request_object = update_job_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::Job::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::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.

Parameters:

  • parent (String) —

    Required. The resource name of the project to search within. The format is "projects/project_id", for example, "projects/api-test-project".

  • search_jobs_request_object (Google::Apis::JobsV3p1beta1::SearchJobsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



628
629
630
631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 628

def search_jobs(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v3p1beta1/{+parent}/jobs:search', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::SearchJobsRequest::Representation
  command.request_object = search_jobs_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::SearchJobsResponse::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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::JobsV3p1beta1::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.

Parameters:

  • parent (String) —

    Required. The resource name of the project to search within. The format is "projects/project_id", for example, "projects/api-test-project".

  • search_jobs_request_object (Google::Apis::JobsV3p1beta1::SearchJobsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



671
672
673
674
675
676
677
678
679
680
681
 
# File 'generated/google/apis/jobs_v3p1beta1/service.rb', line 671

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, 'v3p1beta1/{+parent}/jobs:searchForAlert', options)
  command.request_representation = Google::Apis::JobsV3p1beta1::SearchJobsRequest::Representation
  command.request_object = search_jobs_request_object
  command.response_representation = Google::Apis::JobsV3p1beta1::SearchJobsResponse::Representation
  command.response_class = Google::Apis::JobsV3p1beta1::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