Class: Google::Apis::JobsV2::Job
- Inherits:
-
Object
- Object
- Google::Apis::JobsV2::Job
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/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
-
#application_email_list ⇒ Array<String>
Optional but at least one of application_urls, application_email_list or application_instruction must be specified.
-
#application_instruction ⇒ String
Optional but at least one of application_urls, application_email_list or application_instruction must be specified.
-
#application_urls ⇒ Array<String>
Optional but at least one of application_urls, application_email_list or application_instruction must be specified.
-
#benefits ⇒ Array<String>
Optional.
-
#company_display_name ⇒ String
Output only.
-
#company_name ⇒ String
Optional but one of company_name or distributor_company_id must be provided.
-
#company_title ⇒ String
Deprecated.
-
#compensation_info ⇒ Google::Apis::JobsV2::CompensationInfo
Job compensation details.
-
#create_time ⇒ String
Output only.
-
#custom_attributes ⇒ Hash<String,Google::Apis::JobsV2::CustomAttribute>
Optional.
-
#department ⇒ String
Optional.
-
#description ⇒ String
Required.
-
#distributor_company_id ⇒ String
Optional but one of company_name or distributor_company_id must be provided.
-
#education_levels ⇒ Array<String>
Optional.
-
#employment_types ⇒ Array<String>
Optional.
-
#end_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g.
-
#expire_time ⇒ String
Optional but strongly recommended for the best service experience.
-
#expiry_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g.
-
#extended_compensation_info ⇒ Google::Apis::JobsV2::ExtendedCompensationInfo
Deprecated.
-
#filterable_custom_fields ⇒ Hash<String,Google::Apis::JobsV2::CustomField>
Deprecated.
-
#incentives ⇒ String
Optional.
-
#job_locations ⇒ Array<Google::Apis::JobsV2::JobLocation>
Output only.
-
#job_title ⇒ String
Required.
-
#language_code ⇒ String
Optional.
-
#level ⇒ String
Optional.
-
#locations ⇒ Array<String>
Optional but strongly recommended for the best service experience.
-
#name ⇒ String
Required during job update.
-
#promotion_value ⇒ Fixnum
Optional.
-
#publish_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g.
-
#qualifications ⇒ String
Optional.
-
#reference_url ⇒ String
Output only.
-
#region ⇒ String
Optional.
-
#requisition_id ⇒ String
Required.
-
#responsibilities ⇒ String
Optional.
-
#start_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g.
-
#unindexed_custom_fields ⇒ Hash<String,Google::Apis::JobsV2::CustomField>
Deprecated.
-
#update_time ⇒ String
Output only.
-
#visibility ⇒ String
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Job
constructor
A new instance of Job.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Job
Returns a new instance of Job.
1891 1892 1893 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1891 def initialize(**args) update!(**args) end |
Instance Attribute Details
#application_email_list ⇒ Array<String>
Optional but at least one of application_urls,
application_email_list or application_instruction must be
specified.
Use this field to specify email address(es) to which resumes or
applications can be sent.
The maximum number of allowed characters is 255.
Corresponds to the JSON property applicationEmailList
1522 1523 1524 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1522 def application_email_list @application_email_list end |
#application_instruction ⇒ String
Optional but at least one of application_urls,
application_email_list or application_instruction must be
specified.
Use this field to provide instructions, such as "Mail your application
to ...", that a candidate can follow to apply for the job.
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 3,000.
Corresponds to the JSON property applicationInstruction
1534 1535 1536 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1534 def application_instruction @application_instruction end |
#application_urls ⇒ Array<String>
Optional but at least one of application_urls,
application_email_list or application_instruction must be
specified.
Use this URL field to direct an applicant to a website, for example to
link to an online application form.
The maximum number of allowed characters is 2,000.
Corresponds to the JSON property applicationUrls
1544 1545 1546 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1544 def application_urls @application_urls end |
#benefits ⇒ Array<String>
Optional. The benefits included with the job.
Corresponds to the JSON property benefits
1549 1550 1551 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1549 def benefits @benefits end |
#company_display_name ⇒ String
Output only. The name of the company listing the job.
Corresponds to the JSON property companyDisplayName
1554 1555 1556 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1554 def company_display_name @company_display_name end |
#company_name ⇒ String
Optional but one of company_name or distributor_company_id must be
provided.
The resource name of the company listing the job, such as
/companies/foo. This field takes precedence over the
distributor-assigned company identifier, distributor_company_id.
Corresponds to the JSON property companyName
1563 1564 1565 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1563 def company_name @company_name end |
#company_title ⇒ String
Deprecated. Use company_display_name instead.
Output only.
The name of the company listing the job.
Corresponds to the JSON property companyTitle
1570 1571 1572 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1570 def company_title @company_title end |
#compensation_info ⇒ Google::Apis::JobsV2::CompensationInfo
Job compensation details.
Corresponds to the JSON property compensationInfo
1575 1576 1577 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1575 def compensation_info @compensation_info end |
#create_time ⇒ String
Output only. The timestamp when this job was created.
Corresponds to the JSON property createTime
1580 1581 1582 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1580 def create_time @create_time end |
#custom_attributes ⇒ Hash<String,Google::Apis::JobsV2::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.
This field is a more general combination of the deprecated id-based
filterable_custom_fields and string-based
non_filterable_custom_fields.
The keys of the map are strings up to 64 bytes and must match the
pattern: a-zA-Z*.
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
1597 1598 1599 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1597 def custom_attributes @custom_attributes 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
1604 1605 1606 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1604 def department @department 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
1617 1618 1619 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1617 def description @description end |
#distributor_company_id ⇒ String
Optional but one of company_name or distributor_company_id must be
provided.
A unique company identifier used by job distributors to identify an
employer's company entity. company_name takes precedence over
this field, and is the recommended field to use to identify companies.
The maximum number of allowed characters is 255.
Corresponds to the JSON property distributorCompanyId
1627 1628 1629 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1627 def distributor_company_id @distributor_company_id end |
#education_levels ⇒ Array<String>
Optional. The desired education level for the job, such as
"Bachelors", "Masters", "Doctorate".
Corresponds to the JSON property educationLevels
1633 1634 1635 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1633 def education_levels @education_levels 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
1640 1641 1642 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1640 def employment_types @employment_types end |
#end_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:
- A full date, with non-zero year, month and day values
- A month and day value, with a zero year, e.g. an anniversary
- A year on its own, with zero month and day values
- A year and month value, with a zero day, e.g. a credit card expiration date
Related types are google.type.TimeOfDay and
google.protobuf.Timestamp
. Corresponds to the JSON propertyendDate
1652 1653 1654 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1652 def end_date @end_date end |
#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
requisition_id, company_name and language_code.
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.
The format of this field is RFC 3339 date strings. Example:
2000-01-01T00:00:00.999999999Z
See
https://www.ietf.org/rfc/rfc3339.txt.
A valid date range is between 1970-01-01T00:00:00.0Z and
2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire
time not provided.
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 but expiry_date is, expiry_date is
used.
If this value is not provided on job update, it depends on the field masks
set by UpdateJobRequest.update_job_fields. 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 expireTime
1689 1690 1691 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1689 def expire_time @expire_time end |
#expiry_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:
- A full date, with non-zero year, month and day values
- A month and day value, with a zero year, e.g. an anniversary
- A year on its own, with zero month and day values
- A year and month value, with a zero day, e.g. a credit card expiration date
Related types are google.type.TimeOfDay and
google.protobuf.Timestamp
. Corresponds to the JSON propertyexpiryDate
1701 1702 1703 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1701 def expiry_date @expiry_date end |
#extended_compensation_info ⇒ Google::Apis::JobsV2::ExtendedCompensationInfo
Deprecated. Use CompensationInfo.
Describes job compensation.
Corresponds to the JSON property extendedCompensationInfo
1707 1708 1709 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1707 def extended_compensation_info @extended_compensation_info end |
#filterable_custom_fields ⇒ Hash<String,Google::Apis::JobsV2::CustomField>
Deprecated. Use custom_attributes instead.
Optional.
A map of fields to hold filterable custom job attributes not captured by
the standard fields such as job_title, company_name, or
level. These custom fields store arbitrary
string values, and can be used for purposes not covered by
the structured fields. For the best search experience, use of the
structured rather than custom fields is recommended.
Data stored in these custom fields fields are indexed and
searched against by keyword searches (see
SearchJobsRequest.custom_field_filters][]).
The map key must be a number between 1-20. If an invalid key is
provided on job create or update, an error is returned.
Corresponds to the JSON property filterableCustomFields
1724 1725 1726 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1724 def filterable_custom_fields @filterable_custom_fields 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
1731 1732 1733 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1731 def incentives @incentives end |
#job_locations ⇒ Array<Google::Apis::JobsV2::JobLocation>
Output only. Structured locations of the job, resolved from locations.
Corresponds to the JSON property jobLocations
1736 1737 1738 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1736 def job_locations @job_locations end |
#job_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 jobTitle
1742 1743 1744 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1742 def job_title @job_title 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
1755 1756 1757 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1755 def language_code @language_code end |
#level ⇒ String
Optional. The experience level associated with the job, such as "Entry Level".
Corresponds to the JSON property level
1760 1761 1762 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1760 def level @level end |
#locations ⇒ Array<String>
Optional but strongly recommended for the best service experience.
Location(s) where the emploeyer 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 requisition_id, company_name and
language_code 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 locations
1777 1778 1779 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1777 def locations @locations end |
#name ⇒ String
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.
Corresponds to the JSON property name
1785 1786 1787 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1785 def name @name 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
1795 1796 1797 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1795 def promotion_value @promotion_value end |
#publish_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:
- A full date, with non-zero year, month and day values
- A month and day value, with a zero year, e.g. an anniversary
- A year on its own, with zero month and day values
- A year and month value, with a zero day, e.g. a credit card expiration date
Related types are google.type.TimeOfDay and
google.protobuf.Timestamp
. Corresponds to the JSON propertypublishDate
1807 1808 1809 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1807 def publish_date @publish_date 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
1817 1818 1819 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1817 def qualifications @qualifications end |
#reference_url ⇒ String
Output only. The URL of a web page that displays job details.
Corresponds to the JSON property referenceUrl
1822 1823 1824 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1822 def reference_url @reference_url end |
#region ⇒ String
Optional. The job Region (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 if an exact location match is not specified.
If this field is set, setting job locations
to the same location level as this field is strongly recommended.
Corresponds to the JSON property region
1833 1834 1835 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1833 def region @region 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 listings. A job is not allowed
to be created if there is another job with the same requisition_id,
company_name and language_code.
The maximum number of allowed characters is 255.
Corresponds to the JSON property requisitionId
1844 1845 1846 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1844 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
1854 1855 1856 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1854 def responsibilities @responsibilities end |
#start_date ⇒ Google::Apis::JobsV2::Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:
- A full date, with non-zero year, month and day values
- A month and day value, with a zero year, e.g. an anniversary
- A year on its own, with zero month and day values
- A year and month value, with a zero day, e.g. a credit card expiration date
Related types are google.type.TimeOfDay and
google.protobuf.Timestamp
. Corresponds to the JSON propertystartDate
1866 1867 1868 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1866 def start_date @start_date end |
#unindexed_custom_fields ⇒ Hash<String,Google::Apis::JobsV2::CustomField>
Deprecated. Use custom_attributes instead.
Optional.
A map of fields to hold non-filterable custom job attributes, similar to
filterable_custom_fields. These fields are distinct in that the data
in these fields are not indexed. Therefore, the client cannot search
against them, nor can the client use them to list jobs.
The key of the map can be any valid string.
Corresponds to the JSON property unindexedCustomFields
1877 1878 1879 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1877 def unindexed_custom_fields @unindexed_custom_fields end |
#update_time ⇒ String
Output only. The timestamp when this job was last updated.
Corresponds to the JSON property updateTime
1882 1883 1884 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1882 def update_time @update_time end |
#visibility ⇒ String
Optional. The visibility of the job.
Defaults to JobVisibility.PRIVATE if not specified.
Currently only JobVisibility.PRIVATE is supported.
Corresponds to the JSON property visibility
1889 1890 1891 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1889 def visibility @visibility end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 |
# File 'generated/google/apis/jobs_v2/classes.rb', line 1896 def update!(**args) @application_email_list = args[:application_email_list] if args.key?(:application_email_list) @application_instruction = args[:application_instruction] if args.key?(:application_instruction) @application_urls = args[:application_urls] if args.key?(:application_urls) @benefits = args[:benefits] if args.key?(:benefits) @company_display_name = args[:company_display_name] if args.key?(:company_display_name) @company_name = args[:company_name] if args.key?(:company_name) @company_title = args[:company_title] if args.key?(:company_title) @compensation_info = args[:compensation_info] if args.key?(:compensation_info) @create_time = args[:create_time] if args.key?(:create_time) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @department = args[:department] if args.key?(:department) @description = args[:description] if args.key?(:description) @distributor_company_id = args[:distributor_company_id] if args.key?(:distributor_company_id) @education_levels = args[:education_levels] if args.key?(:education_levels) @employment_types = args[:employment_types] if args.key?(:employment_types) @end_date = args[:end_date] if args.key?(:end_date) @expire_time = args[:expire_time] if args.key?(:expire_time) @expiry_date = args[:expiry_date] if args.key?(:expiry_date) @extended_compensation_info = args[:extended_compensation_info] if args.key?(:extended_compensation_info) @filterable_custom_fields = args[:filterable_custom_fields] if args.key?(:filterable_custom_fields) @incentives = args[:incentives] if args.key?(:incentives) @job_locations = args[:job_locations] if args.key?(:job_locations) @job_title = args[:job_title] if args.key?(:job_title) @language_code = args[:language_code] if args.key?(:language_code) @level = args[:level] if args.key?(:level) @locations = args[:locations] if args.key?(:locations) @name = args[:name] if args.key?(:name) @promotion_value = args[:promotion_value] if args.key?(:promotion_value) @publish_date = args[:publish_date] if args.key?(:publish_date) @qualifications = args[:qualifications] if args.key?(:qualifications) @reference_url = args[:reference_url] if args.key?(:reference_url) @region = args[:region] if args.key?(:region) @requisition_id = args[:requisition_id] if args.key?(:requisition_id) @responsibilities = args[:responsibilities] if args.key?(:responsibilities) @start_date = args[:start_date] if args.key?(:start_date) @unindexed_custom_fields = args[:unindexed_custom_fields] if args.key?(:unindexed_custom_fields) @update_time = args[:update_time] if args.key?(:update_time) @visibility = args[:visibility] if args.key?(:visibility) end |