lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb in google-cloud-talent-0.8.2 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb in google-cloud-talent-0.8.3
- old
+ new
@@ -1,6 +1,6 @@
-# Copyright 2019 Google LLC
+# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
@@ -16,13 +16,12 @@
module Google
module Cloud
module Talent
module V4beta1
# A Job resource represents a job posting (also referred to as a "job listing"
- # or "job requisition"). A job belongs to a
- # {Google::Cloud::Talent::V4beta1::Company Company}, which is the hiring entity
- # responsible for the job.
+ # or "job requisition"). A job belongs to a {Google::Cloud::Talent::V4beta1::Company Company}, which is the hiring
+ # entity responsible for the job.
# @!attribute [rw] name
# @return [String]
# Required during job update.
#
# The resource name for the job. This is generated by the service when a
@@ -34,12 +33,11 @@
#
# If tenant id is unspecified, the default tenant is used. For
# example, "projects/foo/jobs/bar".
#
# Use of this field in job queries and API calls is preferred over the use of
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} since this
- # value is unique.
+ # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} since this value is unique.
# @!attribute [rw] company
# @return [String]
# Required. The resource name of the company listing the job.
#
# The format is
@@ -48,32 +46,29 @@
#
# If tenant id is unspecified, the default tenant is used. For
# example, "projects/foo/companies/bar".
# @!attribute [rw] requisition_id
# @return [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
- # {Google::Cloud::Talent::V4beta1::Job#name company},
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}.
+ # 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 {Google::Cloud::Talent::V4beta1::Job#name company},
+ # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}.
#
# The maximum number of allowed characters is 255.
# @!attribute [rw] title
# @return [String]
# Required. The title of the job, such as "Software Engineer"
#
# The maximum number of allowed characters is 500.
# @!attribute [rw] description
# @return [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
- # {Google::Cloud::Talent::V4beta1::Job#responsibilities responsibilities},
- # {Google::Cloud::Talent::V4beta1::Job#qualifications qualifications}, and other
- # job characteristics. Use of these separate job fields is recommended.
+ # 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 {Google::Cloud::Talent::V4beta1::Job#responsibilities responsibilities},
+ # {Google::Cloud::Talent::V4beta1::Job#qualifications 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.
@@ -86,20 +81,16 @@
# 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
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}s (e.g.
- # 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the
- # same {Google::Cloud::Talent::V4beta1::Job#company company},
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} are not
- # allowed. If the original
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id 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.
+ # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}s (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as
+ # multiple jobs with the same {Google::Cloud::Talent::V4beta1::Job#company company}, {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
+ # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id} are not allowed. If the original {Google::Cloud::Talent::V4beta1::Job#requisition_id 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.
# @!attribute [rw] application_info
# @return [Google::Cloud::Talent::V4beta1::Job::ApplicationInfo]
# Job application information.
@@ -152,15 +143,13 @@
# Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn".
# For more information, see
# [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){:
# class="external" target="_blank" }.
#
- # If this field is unspecified and
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description} is present,
- # detected language code based on
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description} is assigned,
- # otherwise defaults to 'en_US'.
+ # If this field is unspecified and {Google::Cloud::Talent::V4beta1::Job#description Job#description} is present, detected
+ # language code based on {Google::Cloud::Talent::V4beta1::Job#description Job#description} is assigned, otherwise
+ # defaults to 'en_US'.
# @!attribute [rw] job_level
# @return [Google::Cloud::Talent::V4beta1::JobLevel]
# The experience level associated with the job, such as "Entry Level".
# @!attribute [rw] promotion_value
# @return [Integer]
@@ -173,48 +162,42 @@
# Default value is 0, and negative values are treated as 0.
# @!attribute [rw] qualifications
# @return [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
- # {Google::Cloud::Talent::V4beta1::Job#description description} field.
+ # as an alternative to using the more general {Google::Cloud::Talent::V4beta1::Job#description 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.
# @!attribute [rw] responsibilities
# @return [String]
# A description of job responsibilities. The use of this field is
- # recommended as an alternative to using the more general
- # {Google::Cloud::Talent::V4beta1::Job#description description} field.
+ # recommended as an alternative to using the more general {Google::Cloud::Talent::V4beta1::Job#description 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.
# @!attribute [rw] posting_region
# @return [Google::Cloud::Talent::V4beta1::PostingRegion]
- # The job {Google::Cloud::Talent::V4beta1::PostingRegion PostingRegion} (for
- # example, state, country) throughout which the job is available. If this
- # field is set, a
- # {Google::Cloud::Talent::V4beta1::LocationFilter 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
- # {Google::Cloud::Talent::V4beta1::PostingRegion::NATION PostingRegion::NATION} or
- # {Google::Cloud::Talent::V4beta1::PostingRegion::ADMINISTRATIVE_AREA PostingRegion::ADMINISTRATIVE_AREA},
- # setting job {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} to
- # the same location level as this field is strongly recommended.
+ # The job {Google::Cloud::Talent::V4beta1::PostingRegion PostingRegion} (for example, state, country) throughout
+ # which the job is available. If this field is set, a {Google::Cloud::Talent::V4beta1::LocationFilter 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
+ # {Google::Cloud::Talent::V4beta1::PostingRegion::NATION PostingRegion::NATION} or {Google::Cloud::Talent::V4beta1::PostingRegion::ADMINISTRATIVE_AREA PostingRegion::ADMINISTRATIVE_AREA},
+ # setting job {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} to the same location level as this field
+ # is strongly recommended.
# @!attribute [rw] visibility
# @return [Google::Cloud::Talent::V4beta1::Visibility]
# Deprecated. The job is only visible to the owner.
#
# The visibility of the job.
#
- # Defaults to
- # {Google::Cloud::Talent::V4beta1::Visibility::ACCOUNT_ONLY Visibility::ACCOUNT_ONLY}
- # if not specified.
+ # Defaults to {Google::Cloud::Talent::V4beta1::Visibility::ACCOUNT_ONLY Visibility::ACCOUNT_ONLY} if not specified.
# @!attribute [rw] job_start_time
# @return [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.
# @!attribute [rw] job_end_time
@@ -230,22 +213,17 @@
# @return [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
- # {Google::Cloud::Talent::V4beta1::JobService::ListJobs ListJobs} API, but it can
- # be retrieved with the
- # {Google::Cloud::Talent::V4beta1::JobService::GetJob GetJob} API or updated with
- # the {Google::Cloud::Talent::V4beta1::JobService::UpdateJob UpdateJob} API or
- # deleted with the
- # {Google::Cloud::Talent::V4beta1::JobService::DeleteJob 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 {Google::Cloud::Talent::V4beta1::Job#company company},
- # {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and
- # {Google::Cloud::Talent::V4beta1::Job#requisition_id requisition_id}.
+ # expired job can't be listed by the {Google::Cloud::Talent::V4beta1::JobService::ListJobs ListJobs} API,
+ # but it can be retrieved with the {Google::Cloud::Talent::V4beta1::JobService::GetJob GetJob} API or
+ # updated with the {Google::Cloud::Talent::V4beta1::JobService::UpdateJob UpdateJob} API or deleted with
+ # the {Google::Cloud::Talent::V4beta1::JobService::DeleteJob 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 {Google::Cloud::Talent::V4beta1::Job#company company}, {Google::Cloud::Talent::V4beta1::Job#language_code language_code} and {Google::Cloud::Talent::V4beta1::Job#requisition_id 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.
@@ -255,31 +233,27 @@
# 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
- # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time posting_publish_time}
- # must be set before
- # {Google::Cloud::Talent::V4beta1::Job#posting_expire_time posting_expire_time}.
- # The purpose of this feature is to allow other objects, such as
- # {Google::Cloud::Talent::V4beta1::Application 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.
+ # {Google::Cloud::Talent::V4beta1::Job#posting_publish_time posting_publish_time} must be set before
+ # {Google::Cloud::Talent::V4beta1::Job#posting_expire_time posting_expire_time}. The purpose of this feature is
+ # to allow other objects, such as {Google::Cloud::Talent::V4beta1::Application 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
- # {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask UpdateJobRequest#update_mask}.
- # If the field masks include
- # {Google::Cloud::Talent::V4beta1::Job#job_end_time 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.
+ # set by {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask UpdateJobRequest#update_mask}. If the field masks include
+ # {Google::Cloud::Talent::V4beta1::Job#job_end_time 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.
# @!attribute [rw] posting_create_time
# @return [Google::Protobuf::Timestamp]
# Output only. The timestamp when this job posting was created.
# @!attribute [rw] posting_update_time
# @return [Google::Protobuf::Timestamp]
@@ -319,22 +293,17 @@
class ApplicationInfo; end
# Derived details about the job posting.
# @!attribute [rw] locations
# @return [Array<Google::Cloud::Talent::V4beta1::Location>]
- # Structured locations of the job, resolved from
- # {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses}.
+ # Structured locations of the job, resolved from {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses}.
#
- # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations locations} are
- # exactly matched to
- # {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} in the same
+ # {Google::Cloud::Talent::V4beta1::Job::DerivedInfo#locations locations} are exactly matched to {Google::Cloud::Talent::V4beta1::Job#addresses Job#addresses} in the same
# order.
# @!attribute [rw] job_categories
# @return [Array<Google::Cloud::Talent::V4beta1::JobCategory>]
- # Job categories derived from
- # {Google::Cloud::Talent::V4beta1::Job#title Job#title} and
- # {Google::Cloud::Talent::V4beta1::Job#description Job#description}.
+ # Job categories derived from {Google::Cloud::Talent::V4beta1::Job#title Job#title} and {Google::Cloud::Talent::V4beta1::Job#description Job#description}.
class DerivedInfo; end
# Options for job processing.
# @!attribute [rw] disable_street_address_resolution
# @return [true, false]
@@ -351,11 +320,10 @@
# * responsibilities
#
# HTML tags in these fields may be stripped if sanitiazation isn't
# disabled.
#
- # Defaults to
- # {Google::Cloud::Talent::V4beta1::HtmlSanitization::SIMPLE_FORMATTING_ONLY HtmlSanitization::SIMPLE_FORMATTING_ONLY}.
+ # Defaults to {Google::Cloud::Talent::V4beta1::HtmlSanitization::SIMPLE_FORMATTING_ONLY HtmlSanitization::SIMPLE_FORMATTING_ONLY}.
class ProcessingOptions; end
end
end
end
end
\ No newline at end of file