Class: Google::Apis::JobsV3p1beta1::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3p1beta1/classes.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb

Overview

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job



1557
1558
1559
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1557

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#addresses ⇒ Array<String>

Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. Corresponds to the JSON property addresses

Returns:

  • (Array<String>) 


1293
1294
1295
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1293

def addresses
  @addresses
end

#application_info ⇒ Google::Apis::JobsV3p1beta1::ApplicationInfo

Application related details of a job posting. Corresponds to the JSON property applicationInfo

Returns:



1298
1299
1300
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1298

def application_info
  @application_info
end

#company_display_name ⇒ String

Output only. Display name of the company listing the job. Corresponds to the JSON property companyDisplayName

Returns:

  • (String) 


1303
1304
1305
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1303

def company_display_name
  @company_display_name
end

#company_name ⇒ String

Required. The resource name of the company listing the job, such as "projects/api-test-project/companies/foo". Corresponds to the JSON property companyName

Returns:

  • (String) 


1310
1311
1312
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1310

def company_name
  @company_name
end

#compensation_info ⇒ Google::Apis::JobsV3p1beta1::CompensationInfo

Job compensation details. Corresponds to the JSON property compensationInfo

Returns:



1315
1316
1317
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1315

def compensation_info
  @compensation_info
end

#custom_attributes ⇒ Hash<String,Google::Apis::JobsV3p1beta1::CustomAttribute>

Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable string_values, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable string_values, the maximum total size of string_values across all keys is 50KB. Corresponds to the JSON property customAttributes

Returns:



1330
1331
1332
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1330

def custom_attributes
  @custom_attributes
end

#degree_types ⇒ Array<String>

Optional. The desired education degrees for the job, such as Bachelors, Masters. Corresponds to the JSON property degreeTypes

Returns:

  • (Array<String>) 


1336
1337
1338
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1336

def degree_types
  @degree_types
end

#department ⇒ String

Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. Corresponds to the JSON property department

Returns:

  • (String) 


1344
1345
1346
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1344

def department
  @department
end

#derived_info ⇒ Google::Apis::JobsV3p1beta1::JobDerivedInfo

Output only. Derived details about the job posting. Corresponds to the JSON property derivedInfo

Returns:



1350
1351
1352
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1350

def derived_info
  @derived_info
end

#description ⇒ String

Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. Corresponds to the JSON property description

Returns:

  • (String) 


1363
1364
1365
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1363

def description
  @description
end

#employment_types ⇒ Array<String>

Optional. The employment type(s) of a job, for example, full time or part time. Corresponds to the JSON property employmentTypes

Returns:

  • (Array<String>) 


1371
1372
1373
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1371

def employment_types
  @employment_types
end

#incentives ⇒ String

Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. Corresponds to the JSON property incentives

Returns:

  • (String) 


1379
1380
1381
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1379

def incentives
  @incentives
end

#job_benefits ⇒ Array<String>

Optional. The benefits included with the job. Corresponds to the JSON property jobBenefits

Returns:

  • (Array<String>) 


1385
1386
1387
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1385

def job_benefits
  @job_benefits
end

#job_end_time ⇒ String

Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. Corresponds to the JSON property jobEndTime

Returns:

  • (String) 


1392
1393
1394
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1392

def job_end_time
  @job_end_time
end

#job_level ⇒ String

Optional. The experience level associated with the job, such as "Entry Level". Corresponds to the JSON property jobLevel

Returns:

  • (String) 


1398
1399
1400
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1398

def job_level
  @job_level
end

#job_start_time ⇒ String

Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. Corresponds to the JSON property jobStartTime

Returns:

  • (String) 


1405
1406
1407
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1405

def job_start_time
  @job_start_time
end

#language_code ⇒ String

Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages: class="external" target="_blank". If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. Corresponds to the JSON property languageCode

Returns:

  • (String) 


1419
1420
1421
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1419

def language_code
  @language_code
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


1430
1431
1432
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1430

def name
  @name
end

#posting_create_time ⇒ String

Output only. The timestamp when this job posting was created. Corresponds to the JSON property postingCreateTime

Returns:

  • (String) 


1435
1436
1437
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1435

def posting_create_time
  @posting_create_time
end

#posting_expire_time ⇒ String

Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company_name, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. Timestamp before the instant request is made is considered valid, the job will be treated as expired immediately. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. Corresponds to the JSON property postingExpireTime

Returns:

  • (String) 


1466
1467
1468
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1466

def posting_expire_time
  @posting_expire_time
end

#posting_publish_time ⇒ String

Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. Corresponds to the JSON property postingPublishTime

Returns:

  • (String) 


1474
1475
1476
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1474

def posting_publish_time
  @posting_publish_time
end

#posting_region ⇒ String

Optional. The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match is not specified. If this field is set to PostingRegion.NATION_WIDE or [PostingRegion.ADMINISTRATIVE_AREA], setting job addresses to the same location level as this field is strongly recommended. Corresponds to the JSON property postingRegion

Returns:

  • (String) 


1486
1487
1488
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1486

def posting_region
  @posting_region
end

#posting_update_time ⇒ String

Output only. The timestamp when this job posting was last updated. Corresponds to the JSON property postingUpdateTime

Returns:

  • (String) 


1491
1492
1493
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1491

def posting_update_time
  @posting_update_time
end

#processing_options ⇒ Google::Apis::JobsV3p1beta1::ProcessingOptions

Input only. Options for job processing. Corresponds to the JSON property processingOptions

Returns:



1497
1498
1499
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1497

def processing_options
  @processing_options
end

#promotion_value ⇒ Fixnum

Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. Corresponds to the JSON property promotionValue

Returns:

  • (Fixnum) 


1508
1509
1510
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1508

def promotion_value
  @promotion_value
end

#qualifications ⇒ String

Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. Corresponds to the JSON property qualifications

Returns:

  • (String) 


1519
1520
1521
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1519

def qualifications
  @qualifications
end

#requisition_id ⇒ String

Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job is not allowed to be created if there is another job with the same [company_name], language_code and requisition_id. The maximum number of allowed characters is 255. Corresponds to the JSON property requisitionId

Returns:

  • (String) 


1530
1531
1532
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1530

def requisition_id
  @requisition_id
end

#responsibilities ⇒ String

Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. Corresponds to the JSON property responsibilities

Returns:

  • (String) 


1541
1542
1543
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1541

def responsibilities
  @responsibilities
end

#title ⇒ String

Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. Corresponds to the JSON property title

Returns:

  • (String) 


1548
1549
1550
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1548

def title
  @title
end

#visibility ⇒ String

Optional. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. Corresponds to the JSON property visibility

Returns:

  • (String) 


1555
1556
1557
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1555

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 1562

def update!(**args)
  @addresses = args[:addresses] if args.key?(:addresses)
  @application_info = args[:application_info] if args.key?(:application_info)
  @company_display_name = args[:company_display_name] if args.key?(:company_display_name)
  @company_name = args[:company_name] if args.key?(:company_name)
  @compensation_info = args[:compensation_info] if args.key?(:compensation_info)
  @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes)
  @degree_types = args[:degree_types] if args.key?(:degree_types)
  @department = args[:department] if args.key?(:department)
  @derived_info = args[:derived_info] if args.key?(:derived_info)
  @description = args[:description] if args.key?(:description)
  @employment_types = args[:employment_types] if args.key?(:employment_types)
  @incentives = args[:incentives] if args.key?(:incentives)
  @job_benefits = args[:job_benefits] if args.key?(:job_benefits)
  @job_end_time = args[:job_end_time] if args.key?(:job_end_time)
  @job_level = args[:job_level] if args.key?(:job_level)
  @job_start_time = args[:job_start_time] if args.key?(:job_start_time)
  @language_code = args[:language_code] if args.key?(:language_code)
  @name = args[:name] if args.key?(:name)
  @posting_create_time = args[:posting_create_time] if args.key?(:posting_create_time)
  @posting_expire_time = args[:posting_expire_time] if args.key?(:posting_expire_time)
  @posting_publish_time = args[:posting_publish_time] if args.key?(:posting_publish_time)
  @posting_region = args[:posting_region] if args.key?(:posting_region)
  @posting_update_time = args[:posting_update_time] if args.key?(:posting_update_time)
  @processing_options = args[:processing_options] if args.key?(:processing_options)
  @promotion_value = args[:promotion_value] if args.key?(:promotion_value)
  @qualifications = args[:qualifications] if args.key?(:qualifications)
  @requisition_id = args[:requisition_id] if args.key?(:requisition_id)
  @responsibilities = args[:responsibilities] if args.key?(:responsibilities)
  @title = args[:title] if args.key?(:title)
  @visibility = args[:visibility] if args.key?(:visibility)
end