Skip to content

Commit

Permalink
docs(talent): update docstrings (via synth) (#9644)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and busunkim96 committed Nov 8, 2019
1 parent 89e6218 commit d336c63
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class AvailabilitySignalType(enum.IntEnum):
RESUME_UPDATE (int): Resume update signal.
In the context of ``Profile.availability_signals``, this signal is
related to the candidates most recent update to their resume. For a
related to the candidate's most recent update to their resume. For a
``SummarizedProfile.summary``, ``last_update_time`` is calculated from
max(\ ``Profile.resume_update_time``) from all
``SummarizedProfile.profiles``.
Expand All @@ -50,7 +50,7 @@ class AvailabilitySignalType(enum.IntEnum):
CANDIDATE_UPDATE (int): Candidate update signal.
In the context of ``Profile.availability_signals``, this signal is
related to the candidates most recent update to their profile. For a
related to the candidate's most recent update to their profile. For a
``SummarizedProfile.summary``, ``last_update_time`` is calculated from
max(\ ``Profile.candidate_update_time``) from all
``SummarizedProfile.profiles``.
Expand All @@ -60,7 +60,7 @@ class AvailabilitySignalType(enum.IntEnum):
CLIENT_SUBMISSION (int): Client submission signal.
In the context of ``Profile.availability_signals``, this signal is
related to the candidates most recent submission. ``last_update_time``
related to the candidate's most recent submission. ``last_update_time``
is calculated from max(\ ``Application.create_time``) from all
``Application`` records where ``Application.stage`` is any of the
following: ``HIRING_MANAGER_REVIEW`` ``INTERVIEW`` ``OFFER_EXTENDED``
Expand Down Expand Up @@ -958,7 +958,7 @@ class PhoneType(enum.IntEnum):
associated with a particular person, and may be routed to either a
MOBILE or LANDLINE number. The ``phone usage`` should be set to PERSONAL
for these phone types. Some more information can be found here:
http://en.wikipedia.org/wiki/Personal\_Numbers
https://en.wikipedia.org/wiki/Personal\_Numbers
VOIP (int): Voice over IP numbers. This includes TSoIP (Telephony Service over IP).
MOBILE_OR_LANDLINE (int): In some regions (e.g. the USA), it is impossible to distinguish between
fixed-line and mobile numbers by looking at the phone number itself.
Expand Down Expand Up @@ -1015,7 +1015,7 @@ class ResumeType(enum.IntEnum):
Attributes:
RESUME_TYPE_UNSPECIFIED (int): Default value.
HRXML (int): The profile contents in HR-XML format.
See http://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
See https://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
information about Human Resources XML.
OTHER_RESUME_TYPE (int): Resume type not specified.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1640,7 +1640,7 @@ def batch_update_jobs(
The format is "projects/{project\_id}/tenants/{tenant\_id}". For
example, "projects/foo/tenant/bar". If tenant id is unspecified, a
default tenant is created. For example, "projects/foo".
jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): The jobs to be updated.
jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): Required. The jobs to be updated.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.talent_v4beta1.types.Job`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1077,8 +1077,8 @@ enum AvailabilitySignalType {
// In the context of
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals],
// this signal is related to the candidate's most recent application.
// [last_update_time][Profile.availability_signals.last_update_time] is
// calculated from
// [last_update_time][google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time]
// is calculated from
// max([Application.create_time][google.cloud.talent.v4beta1.Application.create_time])
// from all [Application][google.cloud.talent.v4beta1.Application] records
// where [Application.source][google.cloud.talent.v4beta1.Application.source]
Expand All @@ -1093,18 +1093,19 @@ enum AvailabilitySignalType {
// [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the
// filter is applied on
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals]
// where [type][Profile.availability_signals.type] is JOB_APPLICATION.
// where [type][google.cloud.talent.v4beta1.AvailabilitySignal.type] is
// JOB_APPLICATION.
JOB_APPLICATION = 1;

// Resume update signal.
//
// In the context of
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals],
// this signal is related to the candidates most recent update to their
// this signal is related to the candidate's most recent update to their
// resume. For a
// [SummarizedProfile.summary][google.cloud.talent.v4beta1.SummarizedProfile.summary],
// [last_update_time][Profile.availability_signals.last_update_time] is
// calculated from
// [last_update_time][google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time]
// is calculated from
// max([Profile.resume_update_time][google.cloud.talent.v4beta1.Profile.resume_update_time])
// from all
// [SummarizedProfile.profiles][google.cloud.talent.v4beta1.SummarizedProfile.profiles].
Expand All @@ -1113,18 +1114,19 @@ enum AvailabilitySignalType {
// [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the
// filter is applied on
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals]
// where [type][Profile.availability_signals.type] is RESUME_UPDATE.
// where [type][google.cloud.talent.v4beta1.AvailabilitySignal.type] is
// RESUME_UPDATE.
RESUME_UPDATE = 2;

// Candidate update signal.
//
// In the context of
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals],
// this signal is related to the candidates most recent update to their
// this signal is related to the candidate's most recent update to their
// profile. For a
// [SummarizedProfile.summary][google.cloud.talent.v4beta1.SummarizedProfile.summary],
// [last_update_time][Profile.availability_signals.last_update_time] is
// calculated from
// [last_update_time][google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time]
// is calculated from
// max([Profile.candidate_update_time][google.cloud.talent.v4beta1.Profile.candidate_update_time])
// from all
// [SummarizedProfile.profiles][google.cloud.talent.v4beta1.SummarizedProfile.profiles].
Expand All @@ -1133,16 +1135,17 @@ enum AvailabilitySignalType {
// [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the
// filter is applied on
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals]
// where [type][Profile.availability_signals.type] is CANDIDATE_UPDATE.
// where [type][google.cloud.talent.v4beta1.AvailabilitySignal.type] is
// CANDIDATE_UPDATE.
CANDIDATE_UPDATE = 3;

// Client submission signal.
//
// In the context of
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals],
// this signal is related to the candidates most recent submission.
// [last_update_time][Profile.availability_signals.last_update_time] is
// calculated from
// this signal is related to the candidate's most recent submission.
// [last_update_time][google.cloud.talent.v4beta1.AvailabilitySignal.last_update_time]
// is calculated from
// max([Application.create_time][google.cloud.talent.v4beta1.Application.create_time])
// from all [Application][google.cloud.talent.v4beta1.Application] records
// where [Application.stage][google.cloud.talent.v4beta1.Application.stage] is
Expand All @@ -1157,6 +1160,7 @@ enum AvailabilitySignalType {
// [AvailabilityFilter][google.cloud.talent.v4beta1.AvailabilityFilter], the
// filter is applied on
// [Profile.availability_signals][google.cloud.talent.v4beta1.Profile.availability_signals]
// where [type][Profile.availability_signals.type] is CLIENT_SUBMISSION.
// where [type][google.cloud.talent.v4beta1.AvailabilitySignal.type] is
// CLIENT_SUBMISSION.
CLIENT_SUBMISSION = 4;
}
Original file line number Diff line number Diff line change
Expand Up @@ -496,8 +496,8 @@ message LocationFilter {
// or territory. If this field is not set, application behavior is biased
// toward the United States by default.
//
// See http://cldr.unicode.org/ and
// http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
// See https://cldr.unicode.org/ and
// https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
// for details. Example: "CH" for Switzerland.
// Note that this filter is not applicable for Profile Search related queries.
string region_code = 2;
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -866,8 +866,8 @@ message BatchUpdateJobsRequest {
// is created. For example, "projects/foo".
string parent = 1 [(google.api.field_behavior) = REQUIRED];

// The jobs to be updated.
repeated Job jobs = 2;
// Required. The jobs to be updated.
repeated Job jobs = 2 [(google.api.field_behavior) = REQUIRED];

// Strongly recommended for the best service experience. Be aware that it will
// also increase latency when checking the status of a batch operation.
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ message Resume {
RESUME_TYPE_UNSPECIFIED = 0;

// The profile contents in HR-XML format.
// See http://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
// See https://schemas.liquid-technologies.com/hr-xml/2007-04-15/ for more
// information about Human Resources XML.
HRXML = 1;

Expand Down Expand Up @@ -484,7 +484,7 @@ message Phone {
// or LANDLINE number. The [phone
// usage][google.cloud.talent.v4beta1.ContactInfoUsage] should be set to
// PERSONAL for these phone types. Some more information can be found here:
// http://en.wikipedia.org/wiki/Personal_Numbers
// https://en.wikipedia.org/wiki/Personal_Numbers
VIRTUAL = 7;

// Voice over IP numbers. This includes TSoIP (Telephony Service over IP).
Expand Down
10 changes: 5 additions & 5 deletions packages/google-cloud-talent/synth.metadata
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"updateTime": "2019-10-30T12:33:54.698582Z",
"updateTime": "2019-11-08T13:33:27.527945Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.41.0",
"dockerImage": "googleapis/artman@sha256:75b38a3b073a7b243545f2332463096624c802bb1e56b8cb6f22ba1ecd325fa9"
"version": "0.41.1",
"dockerImage": "googleapis/artman@sha256:545c758c76c3f779037aa259023ec3d1ef2d57d2c8cd00a222cb187d63ceac5e"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7c4cf35d5fe3b8ad664bd219edd6d9f28a788b64",
"internalRef": "277334937"
"sha": "d323b287c782802242005072d15f1474d7d10819",
"internalRef": "279234903"
}
},
{
Expand Down

0 comments on commit d336c63

Please sign in to comment.