Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class Job.
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.
Generated from protobuf message google.cloud.talent.v4.Job
Namespace
Google \ Cloud \ Talent \ V4Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ 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".
↳ 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.
↳ title
string
Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
↳ 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.
↳ addresses
array
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_id s (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.
↳ application_info
↳ job_benefits
array
The benefits included with the job.
↳ compensation_info
CompensationInfo
Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
↳ custom_attributes
array| Google\Protobuf\Internal\MapField
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][a-zA-Z0-9_]*
. 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.
↳ degree_types
array
The desired education degrees for the job, such as Bachelors, Masters.
↳ department
string
The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
↳ 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.
↳ 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'.
↳ job_level
int
The experience level associated with the job, such as "Entry Level".
↳ promotion_value
int
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.
↳ 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.
↳ 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.
↳ posting_region
int
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.
↳ visibility
int
Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
↳ job_start_time
Google\Protobuf\Timestamp
The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
↳ job_end_time
Google\Protobuf\Timestamp
The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
↳ posting_publish_time
Google\Protobuf\Timestamp
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.
↳ posting_expire_time
Google\Protobuf\Timestamp
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 ApplicationInfo , 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.
↳ posting_create_time
↳ posting_update_time
↳ company_display_name
string
Output only. Display name of the company listing the job.
↳ derived_info
↳ processing_options
getName
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.
string
setName
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.
var
string
$this
getCompany
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".
string
setCompany
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".
var
string
$this
getRequisitionId
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.
string
setRequisitionId
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.
var
string
$this
getTitle
Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
string
setTitle
Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
var
string
$this
getDescription
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.
string
setDescription
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.
var
string
$this
getAddresses
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_id s (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.
setAddresses
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_id s (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.
var
string[]
$this
getApplicationInfo
Job application information.
hasApplicationInfo
clearApplicationInfo
setApplicationInfo
Job application information.
$this
getJobBenefits
The benefits included with the job.
setJobBenefits
The benefits included with the job.
var
int[]
$this
getCompensationInfo
Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
hasCompensationInfo
clearCompensationInfo
setCompensationInfo
Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee.
$this
getCustomAttributes
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][a-zA-Z0-9_]*
. 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.
setCustomAttributes
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][a-zA-Z0-9_]*
. 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.
$this
getDegreeTypes
The desired education degrees for the job, such as Bachelors, Masters.
setDegreeTypes
The desired education degrees for the job, such as Bachelors, Masters.
var
int[]
$this
getDepartment
The department or functional area within the company with the open position.
The maximum number of allowed characters is 255.
string
setDepartment
The department or functional area within the company with the open position.
The maximum number of allowed characters is 255.
var
string
$this
getEmploymentTypes
setEmploymentTypes
var
int[]
$this
getIncentives
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.
string
setIncentives
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.
var
string
$this
getLanguageCode
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'.
string
setLanguageCode
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'.
var
string
$this
getJobLevel
The experience level associated with the job, such as "Entry Level".
setJobLevel
The experience level associated with the job, such as "Entry Level".
$this
getPromotionValue
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.
int
setPromotionValue
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.
var
int
$this
getQualifications
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.
string
setQualifications
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.
var
string
$this
getResponsibilities
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.
string
setResponsibilities
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.
var
string
$this
getPostingRegion
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.
setPostingRegion
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.
$this
getVisibility
Deprecated. The job is only visible to the owner.
The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
int
setVisibility
Deprecated. The job is only visible to the owner.
The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified.
var
int
Enum of type Visibility .
$this
getJobStartTime
The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
hasJobStartTime
clearJobStartTime
setJobStartTime
The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
$this
getJobEndTime
The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
hasJobEndTime
clearJobEndTime
setJobEndTime
The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored.
$this
getPostingPublishTime
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.
hasPostingPublishTime
clearPostingPublishTime
setPostingPublishTime
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.
$this
getPostingExpireTime
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 ApplicationInfo , 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.
hasPostingExpireTime
clearPostingExpireTime
setPostingExpireTime
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 ApplicationInfo , 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.
$this
getPostingCreateTime
Output only. The timestamp when this job posting was created.
hasPostingCreateTime
clearPostingCreateTime
setPostingCreateTime
Output only. The timestamp when this job posting was created.
$this
getPostingUpdateTime
Output only. The timestamp when this job posting was last updated.
hasPostingUpdateTime
clearPostingUpdateTime
setPostingUpdateTime
Output only. The timestamp when this job posting was last updated.
$this
getCompanyDisplayName
Output only. Display name of the company listing the job.
string
setCompanyDisplayName
Output only. Display name of the company listing the job.
var
string
$this
getDerivedInfo
Output only. Derived details about the job posting.
hasDerivedInfo
clearDerivedInfo
setDerivedInfo
Output only. Derived details about the job posting.
$this
getProcessingOptions
Options for job processing.
hasProcessingOptions
clearProcessingOptions
setProcessingOptions
Options for job processing.
$this

