Class: Google::Apis::JobsV2::Job

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

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



1945
1946
1947
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1945

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

Returns:

  • (Array<String>) 


1563
1564
1565
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1563

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

Returns:

  • (String) 


1575
1576
1577
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1575

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

Returns:

  • (Array<String>) 


1585
1586
1587
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1585

def application_urls
  @application_urls
end

#benefits ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1591
1592
1593
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1591

def benefits
  @benefits
end

#company_display_name ⇒ String

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

Returns:

  • (String) 


1597
1598
1599
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1597

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

Returns:

  • (String) 


1606
1607
1608
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1606

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

Returns:

  • (String) 


1613
1614
1615
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1613

def company_title
  @company_title
end

#compensation_info ⇒ Google::Apis::JobsV2::CompensationInfo

Job compensation details. Corresponds to the JSON property compensationInfo

Returns:



1618
1619
1620
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1618

def compensation_info
  @compensation_info
end

#create_time ⇒ String

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

Returns:

  • (String) 


1624
1625
1626
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1624

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

Returns:



1641
1642
1643
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1641

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

Returns:

  • (String) 


1649
1650
1651
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1649

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

Returns:

  • (String) 


1662
1663
1664
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1662

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

Returns:

  • (String) 


1672
1673
1674
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1672

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

Returns:

  • (Array<String>) 


1679
1680
1681
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1679

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

Returns:

  • (Array<String>) 


1687
1688
1689
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1687

def employment_types
  @employment_types
end

#end_date ⇒ Google::Apis::JobsV2::Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property endDate

Returns:



1698
1699
1700
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1698

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

Returns:

  • (String) 


1737
1738
1739
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1737

def expire_time
  @expire_time
end

#expiry_date ⇒ Google::Apis::JobsV2::Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property expiryDate

Returns:



1748
1749
1750
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1748

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

Returns:



1754
1755
1756
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1754

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

Returns:



1771
1772
1773
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1771

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

Returns:

  • (String) 


1779
1780
1781
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1779

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

Returns:



1785
1786
1787
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1785

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

Returns:

  • (String) 


1792
1793
1794
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1792

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". The default value is en-US. Corresponds to the JSON property languageCode

Returns:

  • (String) 


1804
1805
1806
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1804

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

Returns:

  • (String) 


1810
1811
1812
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1810

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

Returns:

  • (Array<String>) 


1827
1828
1829
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1827

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

Returns:

  • (String) 


1835
1836
1837
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1835

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

Returns:

  • (Fixnum) 


1846
1847
1848
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1846

def promotion_value
  @promotion_value
end

#publish_date ⇒ Google::Apis::JobsV2::Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property publishDate

Returns:



1857
1858
1859
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1857

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

Returns:

  • (String) 


1868
1869
1870
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1868

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

Returns:

  • (String) 


1874
1875
1876
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1874

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

Returns:

  • (String) 


1885
1886
1887
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1885

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

Returns:

  • (String) 


1896
1897
1898
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1896

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) 


1907
1908
1909
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1907

def responsibilities
  @responsibilities
end

#start_date ⇒ Google::Apis::JobsV2::Date

Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property startDate

Returns:



1918
1919
1920
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1918

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

Returns:



1929
1930
1931
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1929

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

Returns:

  • (String) 


1935
1936
1937
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1935

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

Returns:

  • (String) 


1943
1944
1945
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1943

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 1950

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