Class: Google::Apis::JobsV4::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/jobs_v4/classes.rb,
lib/google/apis/jobs_v4/representations.rb,
lib/google/apis/jobs_v4/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

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



1182
1183
1184
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1182

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

Instance Attribute Details

#addresses ⇒ Array<String>

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', and so on.) as multiple jobs with the same company, 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. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and " London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. Corresponds to the JSON property addresses

Returns:

  • (Array<String>) 


954
955
956
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 954

def addresses
  @addresses
end

#application_info ⇒ Google::Apis::JobsV4::ApplicationInfo

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

Returns:



959
960
961
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 959

def application_info
  @application_info
end

#company ⇒ String

Required. The resource name of the company listing the job. The format is " projects/project_id/tenants/tenant_id/companies/company_id". For example, "projects/foo/tenants/bar/companies/baz". Corresponds to the JSON property company

Returns:

  • (String) 


966
967
968
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 966

def company
  @company
end

#company_display_name ⇒ String

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

Returns:

  • (String) 


971
972
973
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 971

def company_display_name
  @company_display_name
end

#compensation_info ⇒ Google::Apis::JobsV4::CompensationInfo

Job compensation details. Corresponds to the JSON property compensationInfo

Returns:



976
977
978
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 976

def compensation_info
  @compensation_info
end

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

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:



988
989
990
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 988

def custom_attributes
  @custom_attributes
end

#degree_types ⇒ Array<String>

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

Returns:

  • (Array<String>) 


993
994
995
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 993

def degree_types
  @degree_types
end

#department ⇒ String

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) 


999
1000
1001
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 999

def department
  @department
end

#derived_info ⇒ Google::Apis::JobsV4::JobDerivedInfo

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

Returns:



1004
1005
1006
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1004

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) 


1015
1016
1017
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1015

def description
  @description
end

#employment_types ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1020
1021
1022
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1020

def employment_types
  @employment_types
end

#incentives ⇒ String

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) 


1027
1028
1029
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1027

def incentives
  @incentives
end

#job_benefits ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1032
1033
1034
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1032

def job_benefits
  @job_benefits
end

#job_end_time ⇒ String

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) 


1038
1039
1040
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1038

def job_end_time
  @job_end_time
end

#job_level ⇒ String

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

Returns:

  • (String) 


1043
1044
1045
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1043

def job_level
  @job_level
end

#job_start_time ⇒ String

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) 


1049
1050
1051
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1049

def job_start_time
  @job_start_time
end

#language_code ⇒ String

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) 


1060
1061
1062
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1060

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/ tenants/tenant_id/jobs/job_id". For example, "projects/foo/tenants/bar/ jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. Corresponds to the JSON property name

Returns:

  • (String) 


1069
1070
1071
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1069

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) 


1074
1075
1076
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1074

def posting_create_time
  @posting_create_time
end

#posting_expire_time ⇒ String

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 listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob 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, 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 number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't 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 isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_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) 


1106
1107
1108
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1106

def posting_expire_time
  @posting_expire_time
end

#posting_publish_time ⇒ String

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) 


1112
1113
1114
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1112

def posting_publish_time
  @posting_publish_time
end

#posting_region ⇒ String

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 isn't specified. If this field is set to PostingRegion.NATION or PostingRegion. ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. Corresponds to the JSON property postingRegion

Returns:

  • (String) 


1122
1123
1124
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1122

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) 


1127
1128
1129
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1127

def posting_update_time
  @posting_update_time
end

#processing_options ⇒ Google::Apis::JobsV4::ProcessingOptions

Options for job processing. Corresponds to the JSON property processingOptions

Returns:



1132
1133
1134
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1132

def processing_options
  @processing_options
end

#promotion_value ⇒ Fixnum

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) 


1142
1143
1144
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1142

def promotion_value
  @promotion_value
end

#qualifications ⇒ String

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) 


1151
1152
1153
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1151

def qualifications
  @qualifications
end

#requisition_id ⇒ String

Required. The requisition ID, also referred to as the posting ID, is 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 isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255. Corresponds to the JSON property requisitionId

Returns:

  • (String) 


1160
1161
1162
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1160

def requisition_id
  @requisition_id
end

#responsibilities ⇒ String

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) 


1168
1169
1170
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1168

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) 


1174
1175
1176
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1174

def title
  @title
end

#visibility ⇒ String

Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. Corresponds to the JSON property visibility

Returns:

  • (String) 


1180
1181
1182
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1180

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 1187

def update!(**args)
  @addresses = args[:addresses] if args.key?(:addresses)
  @application_info = args[:application_info] if args.key?(:application_info)
  @company = args[:company] if args.key?(:company)
  @company_display_name = args[:company_display_name] if args.key?(:company_display_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