lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb in google-cloud-talent-0.1.0 vs lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/job.rb in google-cloud-talent-0.2.0
- old
+ new
@@ -16,43 +16,49 @@
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
# job is created.
#
- # The format is "projects/{project_id}/jobs/{job_id}",
- # for example, "projects/api-test-project/jobs/1234".
+ # The format is
+ # "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for
+ # example, "projects/api-test-project/tenants/foo/jobs/1234".
#
+ # Tenant id is optional and the default tenant is used if unspecified, for
+ # example, "projects/api-test-project/jobs/1234".
+ #
# 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.
- # @!attribute [rw] company_name
+ # {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, such as
- # "projects/api-test-project/companies/foo".
+ # The resource name of the company listing the job.
+ #
+ # The format is
+ # "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for
+ # example, "projects/api-test-project/tenants/foo/companies/bar".
+ #
+ # Tenant id is optional and the default tenant is used if unspecified, for
+ # example, "projects/api-test-project/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}.
+ # 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.
@@ -64,14 +70,13 @@
# @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.
+ # 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.
@@ -84,26 +89,21 @@
# 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', etc.) as multiple jobs with the same
- # {Google::Cloud::Talent::V4beta1::Job#name company}[], {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#name company}[], {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]
- # Required. At least one field within
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo ApplicationInfo} must be
- # specified.
+ # Optional.
#
# Job application information.
# @!attribute [rw] job_benefits
# @return [Array<Google::Cloud::Talent::V4beta1::JobBenefit>]
# Optional.
@@ -111,11 +111,12 @@
# The benefits included with the job.
# @!attribute [rw] compensation_info
# @return [Google::Cloud::Talent::V4beta1::CompensationInfo]
# Optional.
#
- # Job compensation information.
+ # Job compensation information (a.k.a. "pay rate") i.e., the compensation
+ # that will paid to the employee.
# @!attribute [rw] custom_attributes
# @return [Hash{String => Google::Cloud::Talent::V4beta1::CustomAttribute}]
# Optional.
#
# A map of fields to hold both filterable and non-filterable custom job
@@ -168,15 +169,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]
# Optional.
#
# The experience level associated with the job, such as "Entry Level".
@@ -195,52 +194,46 @@
# @return [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
- # {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]
# Optional.
#
# 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]
# Optional.
#
- # 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]
# Optional.
#
# 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]
# Optional.
#
# The start timestamp of the job in UTC time zone. Typically this field
@@ -268,13 +261,11 @@
# 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
- # {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}.
+ # {Google::Cloud::Talent::V4beta1::Job#name company}[], {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 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
@@ -289,15 +280,14 @@
# 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 {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.
+ # set by {Google::Cloud::Talent::V4beta1::UpdateJobRequest#update_mask 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.
# @!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]
@@ -315,42 +305,30 @@
# Options for job processing.
class Job
# Application related details of a job posting.
# @!attribute [rw] emails
# @return [Array<String>]
- # Optional but at least one of
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#uris uris},
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#emails emails} or
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#instruction instruction}
- # must be specified.
+ # Optional.
#
# Use this field to specify email address(es) to which resumes or
# applications can be sent.
#
# The maximum number of allowed characters for each entry is 255.
# @!attribute [rw] instruction
# @return [String]
- # Optional but at least one of
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#uris uris},
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#emails emails} or
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#instruction instruction}
- # must be specified.
+ # Optional.
#
# 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.
# @!attribute [rw] uris
# @return [Array<String>]
- # Optional but at least one of
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#uris uris},
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#emails emails} or
- # {Google::Cloud::Talent::V4beta1::Job::ApplicationInfo#instruction instruction}
- # must be specified.
+ # Optional.
#
# Use this URI field to direct an applicant to a website, for example to
# link to an online application form.
#
# The maximum number of allowed characters for each entry is 2,000.
@@ -359,22 +337,17 @@
# Output only.
#
# 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
# Input only.
#
# Options for job processing.
@@ -397,11 +370,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