Class: Google::Apis::JobsV3::CloudTalentSolutionService

Inherits:
Core::BaseService
  • Object
show all
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.

Examples:

require 'google/apis/jobs_v3'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

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.

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_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.

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_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.

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::JobsV3::BatchDeleteJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



361
362
363
364
365
366
367
368
369
370
371
 
# File 'generated/google/apis/jobs_v3/service.rb', line 361

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', options)
  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.

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) (defaults to: nil) —

    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) (defaults to: nil) —

    Deprecated. Use language_codes instead. Optional. 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 the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255.

  • language_codes (Array<String>, String) (defaults to: nil) —

    Optional. The list of languages 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 the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255.

  • page_size (Fixnum) (defaults to: nil) —

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

  • query (String) (defaults to: nil) —

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

  • scope (String) (defaults to: nil) —

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

  • type (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'generated/google/apis/jobs_v3/service.rb', line 105

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', options)
  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.

Parameters:

  • parent (String) —

    Parent project name.

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

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



147
148
149
150
151
152
153
154
155
156
157
 
# File 'generated/google/apis/jobs_v3/service.rb', line 147

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', options)
  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.

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::JobsV3::CreateCompanyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



181
182
183
184
185
186
187
188
189
190
191
 
# File 'generated/google/apis/jobs_v3/service.rb', line 181

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', options)
  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.

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::JobsV3::CreateJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



396
397
398
399
400
401
402
403
404
405
406
 
# File 'generated/google/apis/jobs_v3/service.rb', line 396

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', options)
  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.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



216
217
218
219
220
221
222
223
224
 
# File 'generated/google/apis/jobs_v3/service.rb', line 216

def delete_project_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  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.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



430
431
432
433
434
435
436
437
438
 
# File 'generated/google/apis/jobs_v3/service.rb', line 430

def delete_project_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v3/{+name}', options)
  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.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



248
249
250
251
252
253
254
255
256
 
# File 'generated/google/apis/jobs_v3/service.rb', line 248

def get_project_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  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.

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



462
463
464
465
466
467
468
469
470
 
# File 'generated/google/apis/jobs_v3/service.rb', line 462

def get_project_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v3/{+name}', options)
  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.

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) (defaults to: nil) —

    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) (defaults to: nil) —

    Optional. The starting indicator from which to return results.

  • require_open_jobs (Boolean) (defaults to: nil) —

    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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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', options)
  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.

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) (defaults to: nil) —

    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) (defaults to: nil) —

    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) (defaults to: nil) —

    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

    1. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
  • page_token (String) (defaults to: nil) —

    Optional. The starting point of a query result.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'generated/google/apis/jobs_v3/service.rb', line 509

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', options)
  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.

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::JobsV3::UpdateCompanyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



327
328
329
330
331
332
333
334
335
336
337
 
# File 'generated/google/apis/jobs_v3/service.rb', line 327

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}', options)
  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.

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::JobsV3::UpdateJobRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



549
550
551
552
553
554
555
556
557
558
559
 
# File 'generated/google/apis/jobs_v3/service.rb', line 549

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}', options)
  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.

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::JobsV3::SearchJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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', options)
  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.

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::JobsV3::SearchJobsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



625
626
627
628
629
630
631
632
633
634
635
 
# File 'generated/google/apis/jobs_v3/service.rb', line 625

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', options)
  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