Class: Google::Apis::JobsV4::CloudTalentSolutionService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/jobs_v4/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_v4'

Jobs = Google::Apis::JobsV4 # 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
50
51
 
# File 'lib/google/apis/jobs_v4/service.rb', line 46

def initialize
  super('https://jobs.googleapis.com/', '',
        client_name: 'google-apis-jobs_v4',
        client_version: Google::Apis::JobsV4::GEM_VERSION)
  @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 'lib/google/apis/jobs_v4/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 'lib/google/apis/jobs_v4/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#batch_project_tenant_job_create(parent, batch_create_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Operation

Begins executing a batch create jobs operation.

Parameters:

  • parent (String) —

    Required. The resource name of the tenant under which the job is created. The format is "projects/project_id/tenants/tenant_id". For example, "projects/ foo/tenants/bar".

  • batch_create_jobs_request_object (Google::Apis::JobsV4::BatchCreateJobsRequest) (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



535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/google/apis/jobs_v4/service.rb', line 535

def batch_project_tenant_job_create(parent, batch_create_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/jobs:batchCreate', options)
  command.request_representation = Google::Apis::JobsV4::BatchCreateJobsRequest::Representation
  command.request_object = batch_create_jobs_request_object
  command.response_representation = Google::Apis::JobsV4::Operation::Representation
  command.response_class = Google::Apis::JobsV4::Operation
  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

#batch_project_tenant_job_delete(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Operation

Begins executing a batch delete jobs operation.

Parameters:

  • parent (String) —

    Required. The resource name of the tenant under which the job is created. The format is "projects/project_id/tenants/tenant_id". For example, "projects/ foo/tenants/bar". The parent of all of the jobs specified in names must match this field.

  • batch_delete_jobs_request_object (Google::Apis::JobsV4::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



571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/google/apis/jobs_v4/service.rb', line 571

def batch_project_tenant_job_delete(parent, batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/jobs:batchDelete', options)
  command.request_representation = Google::Apis::JobsV4::BatchDeleteJobsRequest::Representation
  command.request_object = batch_delete_jobs_request_object
  command.response_representation = Google::Apis::JobsV4::Operation::Representation
  command.response_class = Google::Apis::JobsV4::Operation
  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

#batch_project_tenant_job_update(parent, batch_update_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Operation

Begins executing a batch update jobs operation.

Parameters:

  • parent (String) —

    Required. The resource name of the tenant under which the job is created. The format is "projects/project_id/tenants/tenant_id". For example, "projects/ foo/tenants/bar".

  • batch_update_jobs_request_object (Google::Apis::JobsV4::BatchUpdateJobsRequest) (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



606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/google/apis/jobs_v4/service.rb', line 606

def batch_project_tenant_job_update(parent, batch_update_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/jobs:batchUpdate', options)
  command.request_representation = Google::Apis::JobsV4::BatchUpdateJobsRequest::Representation
  command.request_object = batch_update_jobs_request_object
  command.response_representation = Google::Apis::JobsV4::Operation::Representation
  command.response_class = Google::Apis::JobsV4::Operation
  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_tenant_query(tenant, company: nil, language_codes: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::CompleteQueryResponse

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

Parameters:

  • tenant (String) —

    Required. Resource name of tenant the completion is performed within. The format is "projects/project_id/tenants/tenant_id", for example, "projects/ foo/tenants/bar".

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

    If provided, restricts completion to specified company. The format is " projects/project_id/tenants/tenant_id/companies/company_id", for example, "projects/foo/tenants/bar/companies/baz".

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

    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. 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) —

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

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

    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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/google/apis/jobs_v4/service.rb', line 94

def complete_project_tenant_query(tenant, company: 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, 'v4/{+tenant}:completeQuery', options)
  command.response_representation = Google::Apis::JobsV4::CompleteQueryResponse::Representation
  command.response_class = Google::Apis::JobsV4::CompleteQueryResponse
  command.params['tenant'] = tenant unless tenant.nil?
  command.query['company'] = company unless company.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_project_tenant(parent, tenant_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Tenant

Creates a new tenant entity.

Parameters:

  • parent (String) —

    Required. Resource name of the project under which the tenant is created. The format is "projects/project_id", for example, "projects/foo".

  • tenant_object (Google::Apis::JobsV4::Tenant) (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



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/google/apis/jobs_v4/service.rb', line 132

def create_project_tenant(parent, tenant_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/tenants', options)
  command.request_representation = Google::Apis::JobsV4::Tenant::Representation
  command.request_object = tenant_object
  command.response_representation = Google::Apis::JobsV4::Tenant::Representation
  command.response_class = Google::Apis::JobsV4::Tenant
  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_project_tenant_client_event(parent, client_event_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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) —

    Required. Resource name of the tenant under which the event is created. The format is "projects/project_id/tenants/tenant_id", for example, "projects/ foo/tenants/bar".

  • client_event_object (Google::Apis::JobsV4::ClientEvent) (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



314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/google/apis/jobs_v4/service.rb', line 314

def create_project_tenant_client_event(parent, client_event_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/clientEvents', options)
  command.request_representation = Google::Apis::JobsV4::ClientEvent::Representation
  command.request_object = client_event_object
  command.response_representation = Google::Apis::JobsV4::ClientEvent::Representation
  command.response_class = Google::Apis::JobsV4::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_project_tenant_company(parent, company_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Company

Creates a new company entity.

Parameters:

  • parent (String) —

    Required. Resource name of the tenant under which the company is created. The format is "projects/project_id/tenants/tenant_id", for example, "projects/ foo/tenants/bar".

  • company_object (Google::Apis::JobsV4::Company) (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



349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/google/apis/jobs_v4/service.rb', line 349

def create_project_tenant_company(parent, company_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/companies', options)
  command.request_representation = Google::Apis::JobsV4::Company::Representation
  command.request_object = company_object
  command.response_representation = Google::Apis::JobsV4::Company::Representation
  command.response_class = Google::Apis::JobsV4::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_project_tenant_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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 tenant under which the job is created. The format is "projects/project_id/tenants/tenant_id". For example, "projects/ foo/tenants/bar".

  • job_object (Google::Apis::JobsV4::Job) (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



642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/google/apis/jobs_v4/service.rb', line 642

def create_project_tenant_job(parent, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/jobs', options)
  command.request_representation = Google::Apis::JobsV4::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::JobsV4::Job::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Empty

Deletes specified tenant.

Parameters:

  • name (String) —

    Required. The resource name of the tenant to be deleted. The format is " projects/project_id/tenants/tenant_id", for example, "projects/foo/tenants/ bar".

  • 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



166
167
168
169
170
171
172
173
174
 
# File 'lib/google/apis/jobs_v4/service.rb', line 166

def delete_project_tenant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Empty::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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/tenants/tenant_id/companies/company_id", for example, "projects/foo/tenants/bar/companies/baz".

  • 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



384
385
386
387
388
389
390
391
392
 
# File 'lib/google/apis/jobs_v4/service.rb', line 384

def delete_project_tenant_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Empty::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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/tenants/tenant_id/jobs/job_id". For example, "projects/foo/ tenants/bar/jobs/baz".

  • 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



677
678
679
680
681
682
683
684
685
 
# File 'lib/google/apis/jobs_v4/service.rb', line 677

def delete_project_tenant_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Empty::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Tenant

Retrieves specified tenant.

Parameters:

  • name (String) —

    Required. The resource name of the tenant to be retrieved. The format is " projects/project_id/tenants/tenant_id", for example, "projects/foo/tenants/ bar".

  • 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



198
199
200
201
202
203
204
205
206
 
# File 'lib/google/apis/jobs_v4/service.rb', line 198

def get_project_tenant(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Tenant::Representation
  command.response_class = Google::Apis::JobsV4::Tenant
  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_tenant_company(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Company

Retrieves specified company.

Parameters:

  • name (String) —

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

  • 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



416
417
418
419
420
421
422
423
424
 
# File 'lib/google/apis/jobs_v4/service.rb', line 416

def get_project_tenant_company(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Company::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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/tenants/tenant_id/jobs/job_id". For example, "projects/foo/ tenants/bar/jobs/baz".

  • 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



710
711
712
713
714
715
716
717
718
 
# File 'lib/google/apis/jobs_v4/service.rb', line 710

def get_project_tenant_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+name}', options)
  command.response_representation = Google::Apis::JobsV4::Job::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_companies(parent, page_size: nil, page_token: nil, require_open_jobs: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::ListCompaniesResponse

Lists all companies associated with the project.

Parameters:

  • parent (String) —

    Required. Resource name of the tenant under which the company is created. The format is "projects/project_id/tenants/tenant_id", for example, "projects/ foo/tenants/bar".

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

    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) —

    The starting indicator from which to return results.

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

    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



457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/apis/jobs_v4/service.rb', line 457

def list_project_tenant_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, 'v4/{+parent}/companies', options)
  command.response_representation = Google::Apis::JobsV4::ListCompaniesResponse::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_jobs(parent, filter: nil, job_view: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::ListJobsResponse

Lists jobs by filter.

Parameters:

  • parent (String) —

    Required. The resource name of the tenant under which the job is created. The format is "projects/project_id/tenants/tenant_id". For example, "projects/ foo/tenants/bar".

  • 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 * status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified. Sample Query: * companyName = " projects/foo/tenants/bar/companies/baz" * companyName = "projects/foo/tenants/ bar/companies/baz" AND requisitionId = "req-1" * companyName = "projects/foo/ tenants/bar/companies/baz" AND status = "EXPIRED"

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

    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) —

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

    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



760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/google/apis/jobs_v4/service.rb', line 760

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

#list_project_tenants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::ListTenantsResponse

Lists all tenants associated with the project.

Parameters:

  • parent (String) —

    Required. Resource name of the project under which the tenant is created. The format is "projects/project_id", for example, "projects/foo".

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

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

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

    The starting indicator from which to return results.

  • 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



234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/google/apis/jobs_v4/service.rb', line 234

def list_project_tenants(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v4/{+parent}/tenants', options)
  command.response_representation = Google::Apis::JobsV4::ListTenantsResponse::Representation
  command.response_class = Google::Apis::JobsV4::ListTenantsResponse
  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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_tenant(name, tenant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Tenant

Updates specified tenant.

Parameters:

  • name (String) —

    Required during tenant update. The resource name for a tenant. This is generated by the service when a tenant is created. The format is "projects/ project_id/tenants/tenant_id", for example, "projects/foo/tenants/bar".

  • tenant_object (Google::Apis::JobsV4::Tenant) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.

  • 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



274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/google/apis/jobs_v4/service.rb', line 274

def patch_project_tenant(name, tenant_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/{+name}', options)
  command.request_representation = Google::Apis::JobsV4::Tenant::Representation
  command.request_object = tenant_object
  command.response_representation = Google::Apis::JobsV4::Tenant::Representation
  command.response_class = Google::Apis::JobsV4::Tenant
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_tenant_company(name, company_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::Company

Updates specified company.

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/tenants/tenant_id/companies/company_id", for example, " projects/foo/tenants/bar/companies/baz".

  • company_object (Google::Apis::JobsV4::Company) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to be updated. Only top level fields of Company are supported.

  • 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



499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/google/apis/jobs_v4/service.rb', line 499

def patch_project_tenant_company(name, company_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/{+name}', options)
  command.request_representation = Google::Apis::JobsV4::Company::Representation
  command.request_object = company_object
  command.response_representation = Google::Apis::JobsV4::Company::Representation
  command.response_class = Google::Apis::JobsV4::Company
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_tenant_job(name, job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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/ tenants/tenant_id/jobs/job_id". For example, "projects/foo/tenants/bar/ jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.

  • job_object (Google::Apis::JobsV4::Job) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Strongly recommended for the best service experience. If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

  • 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



805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/google/apis/jobs_v4/service.rb', line 805

def patch_project_tenant_job(name, job_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v4/{+name}', options)
  command.request_representation = Google::Apis::JobsV4::Job::Representation
  command.request_object = job_object
  command.response_representation = Google::Apis::JobsV4::Job::Representation
  command.response_class = Google::Apis::JobsV4::Job
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.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_tenant_job_for_alert(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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), it has different algorithmic adjustments that are designed to specifically target 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 tenant to search within. The format is " projects/project_id/tenants/tenant_id". For example, "projects/foo/tenants/ bar".

  • search_jobs_request_object (Google::Apis::JobsV4::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



884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/google/apis/jobs_v4/service.rb', line 884

def search_project_tenant_job_for_alert(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v4/{+parent}/jobs:searchForAlert', options)
  command.request_representation = Google::Apis::JobsV4::SearchJobsRequest::Representation
  command.request_object = search_jobs_request_object
  command.response_representation = Google::Apis::JobsV4::SearchJobsResponse::Representation
  command.response_class = Google::Apis::JobsV4::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_tenant_jobs(parent, search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::JobsV4::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 tenant to search within. The format is " projects/project_id/tenants/tenant_id". For example, "projects/foo/tenants/ bar".

  • search_jobs_request_object (Google::Apis::JobsV4::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



843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/google/apis/jobs_v4/service.rb', line 843

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