Skip to content

Documentation and formatting changes. #7489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 6, 2019
Merged

Documentation and formatting changes. #7489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions talent/google/cloud/talent_v4beta1/proto/batch.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,12 @@ syntax = "proto3";
package google.cloud.talent.v4beta1;

import "google/api/annotations.proto";
import "google/cloud/talent/v4beta1/job.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
import "google/cloud/talent/v4beta1/job.proto";

option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
option java_multiple_files = true;
option java_outer_classname = "BatchProto";
option java_package = "com.google.cloud.talent.v4beta1";
option objc_class_prefix = "CTS";

8 changes: 4 additions & 4 deletions talent/google/cloud/talent_v4beta1/proto/batch_pb2.py
View file
Open in desktop

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

127 changes: 87 additions & 40 deletions talent/google/cloud/talent_v4beta1/proto/common.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ option java_outer_classname = "CommonProto";
option java_package = "com.google.cloud.talent.v4beta1";
option objc_class_prefix = "CTS";


// Message representing a period of time between two timestamps.
message TimestampRange {
// Begin of the period.
Expand Down Expand Up @@ -187,7 +186,8 @@ enum EmploymentType {
// The job is offered as a contracted position with the understanding
// that it's converted into a full-time position at the end of the
// contract. Jobs of this type are also returned by a search for
// [EmploymentType.CONTRACTOR][google.cloud.talent.v4beta1.EmploymentType.CONTRACTOR] jobs.
// [EmploymentType.CONTRACTOR][google.cloud.talent.v4beta1.EmploymentType.CONTRACTOR]
// jobs.
CONTRACT_TO_HIRE = 4;

// The job is offered as a temporary employment opportunity, usually
Expand Down Expand Up @@ -347,20 +347,23 @@ enum PostingRegion {
POSTING_REGION_UNSPECIFIED = 0;

// In addition to exact location matching, job posting is returned when the
// [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in the search query is in the same administrative area
// as the returned job posting. For example, if a `ADMINISTRATIVE_AREA` job
// is posted in "CA, USA", it's returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has
// "Mountain View".
// [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in the search
// query is in the same administrative area as the returned job posting. For
// example, if a `ADMINISTRATIVE_AREA` job is posted in "CA, USA", it's
// returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter]
// has "Mountain View".
//
// Administrative area refers to top-level administrative subdivision of this
// country. For example, US state, IT region, UK constituent nation and
// JP prefecture.
ADMINISTRATIVE_AREA = 1;

// In addition to exact location matching, job is returned when
// [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in search query is in the same country as this job.
// For example, if a `NATION_WIDE` job is posted in "USA", it's
// returned if [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has 'Mountain View'.
// [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in search
// query is in the same country as this job. For example, if a `NATION_WIDE`
// job is posted in "USA", it's returned if
// [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] has 'Mountain
// View'.
NATION = 2;

// Job allows employees to work remotely (telecommute).
Expand Down Expand Up @@ -514,7 +517,9 @@ message Location {
// conducting the job search. This information is used to improve the
// performance of the service.
message RequestMetadata {
// Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`.
// Required if
// [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids]
// is unset or `false`.
//
// The client-defined scope or source of the service call, which typically
// is the domain on
Expand All @@ -531,7 +536,9 @@ message RequestMetadata {
// The maximum number of allowed characters is 255.
string domain = 1;

// Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`.
// Required if
// [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids]
// is unset or `false`.
//
// A unique session identification string. A session is defined as the
// duration of an end user's interaction with the service over a certain
Expand All @@ -545,7 +552,9 @@ message RequestMetadata {
// The maximum number of allowed characters is 255.
string session_id = 2;

// Required if [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids] is unset or `false`.
// Required if
// [allow_missing_ids][google.cloud.talent.v4beta1.RequestMetadata.allow_missing_ids]
// is unset or `false`.
//
// A unique user identification string, as determined by the client.
// To have the strongest positive impact on search quality
Expand All @@ -561,10 +570,16 @@ message RequestMetadata {

// Optional.
//
// If set to `true`, [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] are optional.
// Only set when any of these fields isn't available for some reason. It
// is highly recommended not to set this field and provide accurate
// [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] for the best service experience.
// If set to `true`,
// [domain][google.cloud.talent.v4beta1.RequestMetadata.domain],
// [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and
// [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] are
// optional. Only set when any of these fields isn't available for some
// reason. It is highly recommended not to set this field and provide accurate
// [domain][google.cloud.talent.v4beta1.RequestMetadata.domain],
// [session_id][google.cloud.talent.v4beta1.RequestMetadata.session_id] and
// [user_id][google.cloud.talent.v4beta1.RequestMetadata.user_id] for the best
// service experience.
bool allow_missing_ids = 4;

// Optional.
Expand Down Expand Up @@ -628,8 +643,10 @@ message DeviceInfo {

// Custom attribute values that are either filterable or non-filterable.
message CustomAttribute {
// Optional but exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] must
// be specified.
// Optional but exactly one of
// [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values]
// or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values]
// must be specified.
//
// This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or
// `CASE_INSENSITIVE_MATCH`) search.
Expand All @@ -641,13 +658,17 @@ message CustomAttribute {
// Empty string isn't allowed.
repeated string string_values = 1;

// Optional but exactly one of [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values] or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] must
// be specified.
// Optional but exactly one of
// [string_values][google.cloud.talent.v4beta1.CustomAttribute.string_values]
// or [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values]
// must be specified.
//
// This field is used to perform number range search.
// (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`.
//
// Currently at most 1 [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] is supported.
// Currently at most 1
// [long_values][google.cloud.talent.v4beta1.CustomAttribute.long_values] is
// supported.
repeated int64 long_values = 2;

// Optional.
Expand Down Expand Up @@ -685,9 +706,17 @@ message CompensationInfo {
// as base pay, bonus, or other compensation type.
//
// Annualization: One compensation entry can be annualized if
// - it contains valid [amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range].
// - and its [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year] is set or can be derived.
// Its annualized range is determined as ([amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]) times
// - it contains valid
// [amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount]
// or
// [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range].
// - and its
// [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year]
// is set or can be derived. Its annualized range is determined as
// ([amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount]
// or
// [range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range])
// times
// [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
message CompensationEntry {
// Optional.
Expand All @@ -701,7 +730,8 @@ message CompensationInfo {
//
// Frequency of the specified amount.
//
// Default is [CompensationUnit.OTHER_COMPENSATION_UNIT][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.OTHER_COMPENSATION_UNIT].
// Default is
// [CompensationUnit.OTHER_COMPENSATION_UNIT][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.OTHER_COMPENSATION_UNIT].
CompensationUnit unit = 2;

// Optional.
Expand Down Expand Up @@ -729,8 +759,10 @@ message CompensationInfo {
// Optional.
//
// Expected number of units paid each year. If not specified, when
// [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types] is FULLTIME, a default value is inferred
// based on [unit][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.unit]. Default values:
// [Job.employment_types][google.cloud.talent.v4beta1.Job.employment_types]
// is FULLTIME, a default value is inferred based on
// [unit][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.unit].
// Default values:
// - HOURLY: 2080
// - DAILY: 260
// - WEEKLY: 52
Expand Down Expand Up @@ -760,19 +792,30 @@ message CompensationInfo {
// The type of compensation.
//
// For compensation amounts specified in non-monetary amounts,
// describe the compensation scheme in the [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description].
// describe the compensation scheme in the
// [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description].
//
// For example, tipping format is described in
// [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] (for example, "expect 15-20% tips based
// on customer bill.") and an estimate of the tips provided in
// [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range] ($10 per hour).
// [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description]
// (for example, "expect 15-20% tips based on customer bill.") and an estimate
// of the tips provided in
// [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount]
// or
// [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]
// ($10 per hour).
//
// For example, equity is described in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description]
// For example, equity is described in
// [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description]
// (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and
// value estimated in [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount] or
// [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range]. If no value estimate is possible, units are
// [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED] and then further
// clarified in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] field.
// value estimated in
// [CompensationEntry.amount][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.amount]
// or
// [CompensationEntry.range][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.range].
// If no value estimate is possible, units are
// [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED]
// and then further clarified in
// [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description]
// field.
enum CompensationType {
// Default value.
COMPENSATION_TYPE_UNSPECIFIED = 0;
Expand Down Expand Up @@ -837,21 +880,25 @@ message CompensationInfo {
// Job compensation information.
//
// At most one entry can be of type
// [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE], which is
// referred as ** base compensation entry ** for the job.
// [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE],
// which is referred as ** base compensation entry ** for the job.
repeated CompensationEntry entries = 1;

// Output only. Annualized base compensation range. Computed as
// base compensation entry's [CompensationEntry.compensation][] times
// [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
//
// See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
// See
// [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry]
// for explanation on compensation annualization.
CompensationRange annualized_base_compensation_range = 2;

// Output only. Annualized total compensation range. Computed as
// all compensation entries' [CompensationEntry.compensation][] times
// [CompensationEntry.expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year].
//
// See [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] for explanation on compensation annualization.
// See
// [CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry]
// for explanation on compensation annualization.
CompensationRange annualized_total_compensation_range = 3;
}
11 changes: 6 additions & 5 deletions talent/google/cloud/talent_v4beta1/proto/company.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,15 @@ syntax = "proto3";

package google.cloud.talent.v4beta1;

import "google/cloud/talent/v4beta1/common.proto";
import "google/api/annotations.proto";
import "google/cloud/talent/v4beta1/common.proto";

option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent";
option java_multiple_files = true;
option java_outer_classname = "CompanyResourceProto";
option java_package = "com.google.cloud.talent.v4beta1";
option objc_class_prefix = "CTS";


// A Company resource represents a company in the service. A company is the
// entity that owns job postings, that is, the hiring entity responsible for
// employing applicants for the job position.
Expand Down Expand Up @@ -70,7 +69,8 @@ message Company {
// The street address of the company's main headquarters, which may be
// different from the job location. The service attempts
// to geolocate the provided address, and populates a more specific
// location wherever possible in [DerivedInfo.headquarters_location][google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location].
// location wherever possible in
// [DerivedInfo.headquarters_location][google.cloud.talent.v4beta1.Company.DerivedInfo.headquarters_location].
string headquarters_address = 5;

// Optional.
Expand Down Expand Up @@ -111,8 +111,9 @@ message Company {

// Optional.
//
// A list of keys of filterable [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes], whose
// corresponding `string_values` are used in keyword search. Jobs with
// A list of keys of filterable
// [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes],
// whose corresponding `string_values` are used in keyword search. Jobs with
// `string_values` under these specified field keys are returned if any
// of the values matches the search keyword. Custom field values with
// parenthesis, brackets and special symbols won't be properly searchable,
Expand Down
Loading