Class: Google::Apis::JobsV3::Job

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



1264
1265
1266
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1264

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. 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>) 


1040
1041
1042
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1040

def addresses
  @addresses
end

#application_info ⇒ Google::Apis::JobsV3::ApplicationInfo

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

Returns:



1045
1046
1047
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1045

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) 


1050
1051
1052
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1050

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) 


1056
1057
1058
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1056

def company_name
  @company_name
end

#compensation_info ⇒ Google::Apis::JobsV3::CompensationInfo

Job compensation details. Corresponds to the JSON property compensationInfo

Returns:



1061
1062
1063
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1061

def compensation_info
  @compensation_info
end

#custom_attributes ⇒ Hash<String,Google::Apis::JobsV3::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:



1073
1074
1075
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1073

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>) 


1079
1080
1081
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1079

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) 


1085
1086
1087
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1085

def department
  @department
end

#derived_info ⇒ Google::Apis::JobsV3::JobDerivedInfo

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

Returns:



1090
1091
1092
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1090

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) 


1101
1102
1103
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1101

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>) 


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

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) 


1113
1114
1115
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1113

def incentives
  @incentives
end

#job_benefits ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1118
1119
1120
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1118

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) 


1124
1125
1126
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1124

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) 


1129
1130
1131
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1129

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) 


1135
1136
1137
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1135

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) 


1146
1147
1148
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1146

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) 


1155
1156
1157
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1155

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) 


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

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) 


1186
1187
1188
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1186

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) 


1193
1194
1195
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1193

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 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) 


1203
1204
1205
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1203

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) 


1208
1209
1210
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1208

def posting_update_time
  @posting_update_time
end

#processing_options ⇒ Google::Apis::JobsV3::ProcessingOptions

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

Returns:



1213
1214
1215
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1213

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) 


1223
1224
1225
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1223

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) 


1232
1233
1234
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1232

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) 


1241
1242
1243
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1241

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) 


1250
1251
1252
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1250

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) 


1256
1257
1258
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1256

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) 


1262
1263
1264
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1262

def visibility
  @visibility
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
 
# File 'lib/google/apis/jobs_v3/classes.rb', line 1269

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