1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module JobsV2
# 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.
#
# @example
# require 'google/apis/jobs_v2'
#
# Jobs = Google::Apis::JobsV2 # Alias the module
# service = Jobs::CloudTalentSolutionService.new
#
# @see https://cloud.google.com/talent-solution/job-search/docs/
class CloudTalentSolutionService < Google::Apis::Core::BaseService
# @return [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.
attr_accessor :key
# @return [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.
attr_accessor :quota_user
def initialize
super('https://jobs.googleapis.com/', '')
@batch_path = 'batch'
end
# Creates a new company entity.
# @param [Google::Apis::JobsV2::Company] company_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Company] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Company]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_company(company_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/companies', options)
command.request_representation = Google::Apis::JobsV2::Company::Representation
command.request_object = company_object
command.response_representation = Google::Apis::JobsV2::Company::Representation
command.response_class = Google::Apis::JobsV2::Company
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified company.
# @param [String] name
# Required. The resource name of the company to be deleted,
# such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_company(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::JobsV2::Empty::Representation
command.response_class = Google::Apis::JobsV2::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified company.
# @param [String] name
# Required. Resource name of the company to retrieve,
# such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Company] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Company]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_company(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::JobsV2::Company::Representation
command.response_class = Google::Apis::JobsV2::Company
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists all companies associated with a Cloud Talent Solution account.
# @param [Boolean] must_have_open_jobs
# Optional. Set to true if the companies request 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.
# @param [Fixnum] page_size
# Optional. The maximum number of companies to be returned, at most 100.
# Default is 100 if a non-positive number is provided.
# @param [String] page_token
# Optional. The starting indicator from which to return results.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::ListCompaniesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::ListCompaniesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_companies(must_have_open_jobs: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/companies', options)
command.response_representation = Google::Apis::JobsV2::ListCompaniesResponse::Representation
command.response_class = Google::Apis::JobsV2::ListCompaniesResponse
command.query['mustHaveOpenJobs'] = must_have_open_jobs unless must_have_open_jobs.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the specified company. Company names can't be updated. To update a
# company name, delete the company and all jobs associated with it, and only
# then re-create them.
# @param [String] name
# Required during company update.
# The resource name for a company. This is generated by the service when a
# company is created, for example,
# "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
# @param [Google::Apis::JobsV2::Company] company_object
# @param [String] update_company_fields
# Optional but strongly recommended to be provided for the best service
# experience.
# If update_company_fields 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 update. Valid values are:
# * displayName
# * website
# * imageUrl
# * companySize
# * distributorBillingCompanyId
# * companyInfoSources
# * careerPageLink
# * hiringAgency
# * hqLocation
# * eeoText
# * keywordSearchableCustomAttributes
# * title (deprecated)
# * keywordSearchableCustomFields (deprecated)
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Company] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Company]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_company(name, company_object = nil, update_company_fields: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::JobsV2::Company::Representation
command.request_object = company_object
command.response_representation = Google::Apis::JobsV2::Company::Representation
command.response_class = Google::Apis::JobsV2::Company
command.params['name'] = name unless name.nil?
command.query['updateCompanyFields'] = update_company_fields unless update_company_fields.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deprecated. Use ListJobs instead.
# Lists all jobs associated with a company.
# @param [String] company_name
# Required. The resource name of the company that owns the jobs to be listed,
# such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
# @param [Boolean] ids_only
# Optional. If set to `true`, only job ID, job requisition ID and language code
# will be
# returned.
# A typical use is to synchronize job repositories.
# Defaults to false.
# @param [Boolean] include_jobs_count
# Deprecated. Please DO NOT use this field except for small companies.
# Suggest counting jobs page by page instead.
# Optional.
# Set to true if the total number of open jobs is to be returned.
# Defaults to false.
# @param [String] job_requisition_id
# Optional. The requisition ID, also known as posting ID, assigned by the
# company
# to the job.
# The maximum number of allowable characters is 225.
# @param [Fixnum] page_size
# Optional. The maximum number of jobs to be returned per page of results.
# If ids_only is set to true, 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.
# @param [String] page_token
# Optional. The starting point of a query result.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::ListCompanyJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::ListCompanyJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_company_jobs(company_name, ids_only: nil, include_jobs_count: nil, job_requisition_id: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+companyName}/jobs', options)
command.response_representation = Google::Apis::JobsV2::ListCompanyJobsResponse::Representation
command.response_class = Google::Apis::JobsV2::ListCompanyJobsResponse
command.params['companyName'] = company_name unless company_name.nil?
command.query['idsOnly'] = ids_only unless ids_only.nil?
command.query['includeJobsCount'] = include_jobs_count unless include_jobs_count.nil?
command.query['jobRequisitionId'] = job_requisition_id unless job_requisition_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a list of Job postings by filter.
# @param [Google::Apis::JobsV2::BatchDeleteJobsRequest] batch_delete_jobs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def batch_delete_jobs(batch_delete_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs:batchDelete', options)
command.request_representation = Google::Apis::JobsV2::BatchDeleteJobsRequest::Representation
command.request_object = batch_delete_jobs_request_object
command.response_representation = Google::Apis::JobsV2::Empty::Representation
command.response_class = Google::Apis::JobsV2::Empty
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new job.
# Typically, the job becomes searchable within 10 seconds, but it may take
# up to 5 minutes.
# @param [Google::Apis::JobsV2::CreateJobRequest] create_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_job(create_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs', options)
command.request_representation = Google::Apis::JobsV2::CreateJobRequest::Representation
command.request_object = create_job_request_object
command.response_representation = Google::Apis::JobsV2::Job::Representation
command.response_class = Google::Apis::JobsV2::Job
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes the specified job.
# Typically, the job becomes unsearchable within 10 seconds, but it may take
# up to 5 minutes.
# @param [String] name
# Required. The resource name of the job to be deleted, such as "jobs/11111111".
# @param [Boolean] disable_fast_process
# Deprecated. This field is not working anymore.
# Optional.
# If set to true, this call waits for all processing steps to complete
# before the job is cleaned up. Otherwise, the call returns while some
# steps are still taking place asynchronously, hence faster.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_job(name, disable_fast_process: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v2/{+name}', options)
command.response_representation = Google::Apis::JobsV2::Empty::Representation
command.response_class = Google::Apis::JobsV2::Empty
command.params['name'] = name unless name.nil?
command.query['disableFastProcess'] = disable_fast_process unless disable_fast_process.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deprecated. Use BatchDeleteJobs instead.
# Deletes the specified job by filter. You can specify whether to
# synchronously wait for validation, indexing, and general processing to be
# completed before the response is returned.
# @param [Google::Apis::JobsV2::DeleteJobsByFilterRequest] delete_jobs_by_filter_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_job_by_filter(delete_jobs_by_filter_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs:deleteByFilter', options)
command.request_representation = Google::Apis::JobsV2::DeleteJobsByFilterRequest::Representation
command.request_object = delete_jobs_by_filter_request_object
command.response_representation = Google::Apis::JobsV2::Empty::Representation
command.response_class = Google::Apis::JobsV2::Empty
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Retrieves the specified job, whose status is OPEN or recently EXPIRED
# within the last 90 days.
# @param [String] name
# Required. The resource name of the job to retrieve, such as "jobs/11111111".
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_job(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/{+name}', options)
command.response_representation = Google::Apis::JobsV2::Job::Representation
command.response_class = Google::Apis::JobsV2::Job
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deprecated. Use SearchJobsRequest.histogram_facets instead to make
# a single call with both search and histogram.
# Retrieves a histogram for the given
# GetHistogramRequest. This call provides a structured
# count of jobs that match against the search query, grouped by specified
# facets.
# This call constrains the visibility of jobs
# present in the database, and only counts jobs the caller has
# permission to search against.
# For example, use this call to generate the
# number of jobs in the U.S. by state.
# @param [Google::Apis::JobsV2::GetHistogramRequest] get_histogram_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::GetHistogramResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::GetHistogramResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def histogram_job(get_histogram_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs:histogram', options)
command.request_representation = Google::Apis::JobsV2::GetHistogramRequest::Representation
command.request_object = get_histogram_request_object
command.response_representation = Google::Apis::JobsV2::GetHistogramResponse::Representation
command.response_class = Google::Apis::JobsV2::GetHistogramResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists jobs by filter.
# @param [String] filter
# 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 = "companies/123"
# * companyName = "companies/123" AND requisitionId = "req-1"
# @param [Boolean] ids_only
# Optional. If set to `true`, only Job.name, Job.requisition_id and
# Job.language_code will be returned.
# A typical use case is to synchronize job repositories.
# Defaults to false.
# @param [Fixnum] page_size
# Optional. The maximum number of jobs to be returned per page of results.
# If ids_only is set to true, 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.
# @param [String] page_token
# Optional. The starting point of a query result.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::ListJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::ListJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_jobs(filter: nil, ids_only: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2/jobs', options)
command.response_representation = Google::Apis::JobsV2::ListJobsResponse::Representation
command.response_class = Google::Apis::JobsV2::ListJobsResponse
command.query['filter'] = filter unless filter.nil?
command.query['idsOnly'] = ids_only unless ids_only.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates specified job.
# Typically, updated contents become visible in search results within 10
# seconds, but it may take up to 5 minutes.
# @param [String] name
# Required during job update.
# Resource name assigned to a job by the API, for example, "/jobs/foo". Use
# of this field in job queries and API calls is preferred over the use of
# requisition_id since this value is unique.
# @param [Google::Apis::JobsV2::UpdateJobRequest] update_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def patch_job(name, update_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v2/{+name}', options)
command.request_representation = Google::Apis::JobsV2::UpdateJobRequest::Representation
command.request_object = update_job_request_object
command.response_representation = Google::Apis::JobsV2::Job::Representation
command.response_class = Google::Apis::JobsV2::Job
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [Google::Apis::JobsV2::SearchJobsRequest] search_jobs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::SearchJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::SearchJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_jobs(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs:search', options)
command.request_representation = Google::Apis::JobsV2::SearchJobsRequest::Representation
command.request_object = search_jobs_request_object
command.response_representation = Google::Apis::JobsV2::SearchJobsResponse::Representation
command.response_class = Google::Apis::JobsV2::SearchJobsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# 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.
# @param [Google::Apis::JobsV2::SearchJobsRequest] search_jobs_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::SearchJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::SearchJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def search_job_for_alert(search_jobs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v2/jobs:searchForAlert', options)
command.request_representation = Google::Apis::JobsV2::SearchJobsRequest::Representation
command.request_object = search_jobs_request_object
command.response_representation = Google::Apis::JobsV2::SearchJobsResponse::Representation
command.response_class = Google::Apis::JobsV2::SearchJobsResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Completes the specified prefix with job keyword suggestions.
# Intended for use by a job search auto-complete search box.
# @param [String] company_name
# Optional. If provided, restricts completion to the specified company.
# @param [String] language_code
# 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](https://tools.ietf.org/html/bcp47).
# 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.
# @param [Fixnum] page_size
# Required. Completion result count.
# The maximum allowed page size is 10.
# @param [String] query
# Required. The query used to generate suggestions.
# @param [String] scope
# Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
# @param [String] type
# Optional. The completion topic. The default is CompletionType.COMBINED.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::JobsV2::CompleteQueryResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::JobsV2::CompleteQueryResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def complete(company_name: nil, language_code: nil, page_size: nil, query: nil, scope: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v2:complete', options)
command.response_representation = Google::Apis::JobsV2::CompleteQueryResponse::Representation
command.response_class = Google::Apis::JobsV2::CompleteQueryResponse
command.query['companyName'] = company_name unless company_name.nil?
command.query['languageCode'] = language_code unless language_code.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['query'] = query unless query.nil?
command.query['scope'] = scope unless scope.nil?
command.query['type'] = type unless type.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|