diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/company_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/company_service/client.py index 340ada4dda1f..9e7df0152d48 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/company_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/company_service/client.py @@ -1044,7 +1044,7 @@ def sample_list_companies(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "CompanyServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/completion/client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/completion/client.py index 5a057ee628d9..53420aa0b14c 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/completion/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/completion/client.py @@ -537,7 +537,7 @@ def sample_complete_query(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "CompletionClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/event_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/event_service/client.py index 3c945716da4b..c6a3eb5441ff 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/event_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/event_service/client.py @@ -571,7 +571,7 @@ def sample_create_client_event(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "EventServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/async_client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/async_client.py index 04f7130de7ca..cd1dde168264 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/async_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/async_client.py @@ -427,8 +427,9 @@ async def sample_batch_create_jobs(): google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchCreateJobsResponse` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchCreateJobsResponse` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. @@ -812,8 +813,9 @@ async def sample_batch_update_jobs(): google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchUpdateJobsResponse` The result of [JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchUpdateJobsResponse` The result of + [JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. @@ -1055,8 +1057,9 @@ async def sample_batch_delete_jobs(): google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchDeleteJobsResponse` The result of [JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchDeleteJobsResponse` The result of + [JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/client.py index ca6daa41a5fe..bbbadb63e8d4 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/job_service/client.py @@ -693,8 +693,9 @@ def sample_batch_create_jobs(): google.api_core.operation.Operation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchCreateJobsResponse` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchCreateJobsResponse` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4.JobService.BatchCreateJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. @@ -1068,8 +1069,9 @@ def sample_batch_update_jobs(): google.api_core.operation.Operation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchUpdateJobsResponse` The result of [JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchUpdateJobsResponse` The result of + [JobService.BatchUpdateJobs][google.cloud.talent.v4.JobService.BatchUpdateJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. @@ -1301,8 +1303,9 @@ def sample_batch_delete_jobs(): google.api_core.operation.Operation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchDeleteJobsResponse` The result of [JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. It's used to - replace + The result type for the operation will be :class:`google.cloud.talent_v4.types.BatchDeleteJobsResponse` The result of + [JobService.BatchDeleteJobs][google.cloud.talent.v4.JobService.BatchDeleteJobs]. + It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] in case of success. @@ -1688,7 +1691,7 @@ def sample_search_jobs_for_alert(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "JobServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/services/tenant_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4/services/tenant_service/client.py index 50348c6b4835..22f055015db6 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/services/tenant_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/services/tenant_service/client.py @@ -1014,7 +1014,7 @@ def sample_list_tenants(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "TenantServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/common.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/common.py index f98a1753a18f..2cf1a12fde69 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/common.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/common.py @@ -49,7 +49,30 @@ class CompanySize(proto.Enum): - r"""An enum that represents the size of the company.""" + r"""An enum that represents the size of the company. + + Values: + COMPANY_SIZE_UNSPECIFIED (0): + Default value if the size isn't specified. + MINI (1): + The company has less than 50 employees. + SMALL (2): + The company has between 50 and 99 employees. + SMEDIUM (3): + The company has between 100 and 499 + employees. + MEDIUM (4): + The company has between 500 and 999 + employees. + BIG (5): + The company has between 1,000 and 4,999 + employees. + BIGGER (6): + The company has between 5,000 and 9,999 + employees. + GIANT (7): + The company has 10,000 or more employees. + """ COMPANY_SIZE_UNSPECIFIED = 0 MINI = 1 SMALL = 2 @@ -63,6 +86,43 @@ class CompanySize(proto.Enum): class JobBenefit(proto.Enum): r"""An enum that represents employee benefits included with the job. + + Values: + JOB_BENEFIT_UNSPECIFIED (0): + Default value if the type isn't specified. + CHILD_CARE (1): + The job includes access to programs that + support child care, such as daycare. + DENTAL (2): + The job includes dental services covered by a + dental insurance plan. + DOMESTIC_PARTNER (3): + The job offers specific benefits to domestic + partners. + FLEXIBLE_HOURS (4): + The job allows for a flexible work schedule. + MEDICAL (5): + The job includes health services covered by a + medical insurance plan. + LIFE_INSURANCE (6): + The job includes a life insurance plan + provided by the employer or available for + purchase by the employee. + PARENTAL_LEAVE (7): + The job allows for a leave of absence to a + parent to care for a newborn child. + RETIREMENT_PLAN (8): + The job includes a workplace retirement plan + provided by the employer or available for + purchase by the employee. + SICK_DAYS (9): + The job allows for paid time off due to + illness. + VACATION (10): + The job includes paid time off for vacation. + VISION (11): + The job includes vision services covered by a + vision insurance plan. """ JOB_BENEFIT_UNSPECIFIED = 0 CHILD_CARE = 1 @@ -81,6 +141,62 @@ class JobBenefit(proto.Enum): class DegreeType(proto.Enum): r"""Educational degree level defined in International Standard Classification of Education (ISCED). + + Values: + DEGREE_TYPE_UNSPECIFIED (0): + Default value. Represents no degree, or early + childhood education. Maps to ISCED code 0. + Ex) Kindergarten + PRIMARY_EDUCATION (1): + Primary education which is typically the + first stage of compulsory education. ISCED code + 1. Ex) Elementary school + LOWER_SECONDARY_EDUCATION (2): + Lower secondary education; First stage of + secondary education building on primary + education, typically with a more + subject-oriented curriculum. ISCED code 2. + Ex) Middle school + UPPER_SECONDARY_EDUCATION (3): + Middle education; Second/final stage of + secondary education preparing for tertiary + education and/or providing skills relevant to + employment. Usually with an increased range of + subject options and streams. ISCED code 3. + Ex) High school + ADULT_REMEDIAL_EDUCATION (4): + Adult Remedial Education; Programmes + providing learning experiences that build on + secondary education and prepare for labour + market entry and/or tertiary education. The + content is broader than secondary but not as + complex as tertiary education. ISCED code 4. + ASSOCIATES_OR_EQUIVALENT (5): + Associate's or equivalent; Short first + tertiary programmes that are typically + practically-based, occupationally-specific and + prepare for labour market entry. These + programmes may also provide a pathway to other + tertiary programmes. ISCED code 5. + BACHELORS_OR_EQUIVALENT (6): + Bachelor's or equivalent; Programmes designed + to provide intermediate academic and/or + professional knowledge, skills and competencies + leading to a first tertiary degree or equivalent + qualification. ISCED code 6. + MASTERS_OR_EQUIVALENT (7): + Master's or equivalent; Programmes designed + to provide advanced academic and/or professional + knowledge, skills and competencies leading to a + second tertiary degree or equivalent + qualification. ISCED code 7. + DOCTORAL_OR_EQUIVALENT (8): + Doctoral or equivalent; Programmes designed + primarily to lead to an advanced research + qualification, usually concluding with the + submission and defense of a substantive + dissertation of publishable quality based on + original research. ISCED code 8. """ DEGREE_TYPE_UNSPECIFIED = 0 PRIMARY_EDUCATION = 1 @@ -94,7 +210,54 @@ class DegreeType(proto.Enum): class EmploymentType(proto.Enum): - r"""An enum that represents the employment type of a job.""" + r"""An enum that represents the employment type of a job. + + Values: + EMPLOYMENT_TYPE_UNSPECIFIED (0): + The default value if the employment type + isn't specified. + FULL_TIME (1): + The job requires working a number of hours + that constitute full time employment, typically + 40 or more hours per week. + PART_TIME (2): + The job entails working fewer hours than a + full time job, typically less than 40 hours a + week. + CONTRACTOR (3): + The job is offered as a contracted, as + opposed to a salaried employee, position. + CONTRACT_TO_HIRE (4): + 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.v4.EmploymentType.CONTRACTOR] + jobs. + TEMPORARY (5): + The job is offered as a temporary employment + opportunity, usually a short-term engagement. + INTERN (6): + The job is a fixed-term opportunity for + students or entry-level job seekers to obtain + on-the-job training, typically offered as a + summer position. + VOLUNTEER (7): + The is an opportunity for an individual to + volunteer, where there's no expectation of + compensation for the provided services. + PER_DIEM (8): + The job requires an employee to work on an + as-needed basis with a flexible schedule. + FLY_IN_FLY_OUT (9): + The job involves employing people in remote + areas and flying them temporarily to the work + site instead of relocating employees and their + families permanently. + OTHER_EMPLOYMENT_TYPE (10): + The job does not fit any of the other listed + types. + """ EMPLOYMENT_TYPE_UNSPECIFIED = 0 FULL_TIME = 1 PART_TIME = 2 @@ -111,6 +274,28 @@ class EmploymentType(proto.Enum): class JobLevel(proto.Enum): r"""An enum that represents the required experience level required for the job. + + Values: + JOB_LEVEL_UNSPECIFIED (0): + The default value if the level isn't + specified. + ENTRY_LEVEL (1): + Entry-level individual contributors, + typically with less than 2 years of experience + in a similar role. Includes interns. + EXPERIENCED (2): + Experienced individual contributors, + typically with 2+ years of experience in a + similar role. + MANAGER (3): + Entry- to mid-level managers responsible for + managing a team of people. + DIRECTOR (4): + Senior-level managers responsible for + managing teams of managers. + EXECUTIVE (5): + Executive-level managers and above, including + C-level positions. """ JOB_LEVEL_UNSPECIFIED = 0 ENTRY_LEVEL = 1 @@ -125,6 +310,94 @@ class JobCategory(proto.Enum): of specific role. This value is different than the "industry" associated with a role, which is related to the categorization of the company listing the job. + + Values: + JOB_CATEGORY_UNSPECIFIED (0): + The default value if the category isn't + specified. + ACCOUNTING_AND_FINANCE (1): + An accounting and finance job, such as an + Accountant. + ADMINISTRATIVE_AND_OFFICE (2): + An administrative and office job, such as an + Administrative Assistant. + ADVERTISING_AND_MARKETING (3): + An advertising and marketing job, such as + Marketing Manager. + ANIMAL_CARE (4): + An animal care job, such as Veterinarian. + ART_FASHION_AND_DESIGN (5): + An art, fashion, or design job, such as + Designer. + BUSINESS_OPERATIONS (6): + A business operations job, such as Business + Operations Manager. + CLEANING_AND_FACILITIES (7): + A cleaning and facilities job, such as + Custodial Staff. + COMPUTER_AND_IT (8): + A computer and IT job, such as Systems + Administrator. + CONSTRUCTION (9): + A construction job, such as General Laborer. + CUSTOMER_SERVICE (10): + A customer service job, such s Cashier. + EDUCATION (11): + An education job, such as School Teacher. + ENTERTAINMENT_AND_TRAVEL (12): + An entertainment and travel job, such as + Flight Attendant. + FARMING_AND_OUTDOORS (13): + A farming or outdoor job, such as Park + Ranger. + HEALTHCARE (14): + A healthcare job, such as Registered Nurse. + HUMAN_RESOURCES (15): + A human resources job, such as Human + Resources Director. + INSTALLATION_MAINTENANCE_AND_REPAIR (16): + An installation, maintenance, or repair job, + such as Electrician. + LEGAL (17): + A legal job, such as Law Clerk. + MANAGEMENT (18): + A management job, often used in conjunction + with another category, such as Store Manager. + MANUFACTURING_AND_WAREHOUSE (19): + A manufacturing or warehouse job, such as + Assembly Technician. + MEDIA_COMMUNICATIONS_AND_WRITING (20): + A media, communications, or writing job, such + as Media Relations. + OIL_GAS_AND_MINING (21): + An oil, gas or mining job, such as Offshore + Driller. + PERSONAL_CARE_AND_SERVICES (22): + A personal care and services job, such as + Hair Stylist. + PROTECTIVE_SERVICES (23): + A protective services job, such as Security + Guard. + REAL_ESTATE (24): + A real estate job, such as Buyer's Agent. + RESTAURANT_AND_HOSPITALITY (25): + A restaurant and hospitality job, such as + Restaurant Server. + SALES_AND_RETAIL (26): + A sales and/or retail job, such Sales + Associate. + SCIENCE_AND_ENGINEERING (27): + A science and engineering job, such as Lab + Technician. + SOCIAL_SERVICES_AND_NON_PROFIT (28): + A social services or non-profit job, such as + Case Worker. + SPORTS_FITNESS_AND_RECREATION (29): + A sports, fitness, or recreation job, such as + Personal Trainer. + TRANSPORTATION_AND_LOGISTICS (30): + A transportation or logistics job, such as + Truck Driver. """ JOB_CATEGORY_UNSPECIFIED = 0 ACCOUNTING_AND_FINANCE = 1 @@ -164,6 +437,39 @@ class PostingRegion(proto.Enum): cases, job postings don't need to specify a region. If a region is given, jobs are eligible for searches in the specified region. + + Values: + POSTING_REGION_UNSPECIFIED (0): + If the region is unspecified, the job is only returned if it + matches the + [LocationFilter][google.cloud.talent.v4.LocationFilter]. + ADMINISTRATIVE_AREA (1): + In addition to exact location matching, job posting is + returned when the + [LocationFilter][google.cloud.talent.v4.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.v4.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. + NATION (2): + In addition to exact location matching, job is returned when + [LocationFilter][google.cloud.talent.v4.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.v4.LocationFilter] has + 'Mountain View'. + TELECOMMUTE (3): + Job allows employees to work remotely + (telecommute). If locations are provided with + this value, the job is considered as having a + location, but telecommuting is allowed. """ POSTING_REGION_UNSPECIFIED = 0 ADMINISTRATIVE_AREA = 1 @@ -174,6 +480,20 @@ class PostingRegion(proto.Enum): class Visibility(proto.Enum): r"""Deprecated. All resources are only visible to the owner. An enum that represents who has view access to the resource. + + Values: + VISIBILITY_UNSPECIFIED (0): + Default value. + ACCOUNT_ONLY (1): + The resource is only visible to the GCP + account who owns it. + SHARED_WITH_GOOGLE (2): + The resource is visible to the owner and may + be visible to other applications and processes + at Google. + SHARED_WITH_PUBLIC (3): + The resource is visible to the owner and may + be visible to all other API clients. """ _pb_options = {"deprecated": True} VISIBILITY_UNSPECIFIED = 0 @@ -187,6 +507,16 @@ class HtmlSanitization(proto.Enum): for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields. + + Values: + HTML_SANITIZATION_UNSPECIFIED (0): + Default value. + HTML_SANITIZATION_DISABLED (1): + Disables sanitization on HTML input. + SIMPLE_FORMATTING_ONLY (2): + Sanitizes HTML input, only accepts bold, + italic, ordered list, and unordered list markup + tags. """ HTML_SANITIZATION_UNSPECIFIED = 0 HTML_SANITIZATION_DISABLED = 1 @@ -196,6 +526,25 @@ class HtmlSanitization(proto.Enum): class CommuteMethod(proto.Enum): r"""Method for commute. Walking, biking and wheelchair accessible transit is still in the Preview stage. + + Values: + COMMUTE_METHOD_UNSPECIFIED (0): + Commute method isn't specified. + DRIVING (1): + Commute time is calculated based on driving + time. + TRANSIT (2): + Commute time is calculated based on public + transit including bus, metro, subway, and so on. + WALKING (3): + Commute time is calculated based on walking + time. + CYCLING (4): + Commute time is calculated based on biking + time. + TRANSIT_ACCESSIBLE (5): + Commute time is calculated based on public + transit that is wheelchair accessible. """ COMMUTE_METHOD_UNSPECIFIED = 0 DRIVING = 1 @@ -259,7 +608,39 @@ class Location(proto.Message): """ class LocationType(proto.Enum): - r"""An enum which represents the type of a location.""" + r"""An enum which represents the type of a location. + + Values: + LOCATION_TYPE_UNSPECIFIED (0): + Default value if the type isn't specified. + COUNTRY (1): + A country level location. + ADMINISTRATIVE_AREA (2): + A state or equivalent level location. + SUB_ADMINISTRATIVE_AREA (3): + A county or equivalent level location. + LOCALITY (4): + A city or equivalent level location. + POSTAL_CODE (5): + A postal code level location. + SUB_LOCALITY (6): + A sublocality is a subdivision of a locality, + for example a city borough, ward, or + arrondissement. Sublocalities are usually + recognized by a local political authority. For + example, Manhattan and Brooklyn are recognized + as boroughs by the City of New York, and are + therefore modeled as sublocalities. + SUB_LOCALITY_1 (7): + A district or equivalent level location. + SUB_LOCALITY_2 (8): + A smaller district or equivalent level + display. + NEIGHBORHOOD (9): + A neighborhood level location. + STREET_ADDRESS (10): + A street address level location. + """ LOCATION_TYPE_UNSPECIFIED = 0 COUNTRY = 1 ADMINISTRATIVE_AREA = 2 @@ -424,6 +805,25 @@ class DeviceInfo(proto.Message): class DeviceType(proto.Enum): r"""An enumeration describing an API access portal and exposure mechanism. + + Values: + DEVICE_TYPE_UNSPECIFIED (0): + The device type isn't specified. + WEB (1): + A desktop web browser, such as, Chrome, + Firefox, Safari, or Internet Explorer) + MOBILE_WEB (2): + A mobile device web browser, such as a phone + or tablet with a Chrome browser. + ANDROID (3): + An Android device native application. + IOS (4): + An iOS device native application. + BOT (5): + A bot, as opposed to a device operated by + human beings, such as a web crawler. + OTHER (6): + Other devices types. """ DEVICE_TYPE_UNSPECIFIED = 0 WEB = 1 @@ -609,6 +1009,30 @@ class CompensationType(proto.Enum): and then further clarified in [CompensationEntry.description][google.cloud.talent.v4.CompensationInfo.CompensationEntry.description] field. + + Values: + COMPENSATION_TYPE_UNSPECIFIED (0): + Default value. + BASE (1): + Base compensation: Refers to the fixed amount + of money paid to an employee by an employer in + return for work performed. Base compensation + does not include benefits, bonuses or any other + potential compensation from an employer. + BONUS (2): + Bonus. + SIGNING_BONUS (3): + Signing bonus. + EQUITY (4): + Equity. + PROFIT_SHARING (5): + Profit sharing. + COMMISSIONS (6): + Commission. + TIPS (7): + Tips. + OTHER_COMPENSATION_TYPE (8): + Other compensation type. """ COMPENSATION_TYPE_UNSPECIFIED = 0 BASE = 1 @@ -621,7 +1045,26 @@ class CompensationType(proto.Enum): OTHER_COMPENSATION_TYPE = 8 class CompensationUnit(proto.Enum): - r"""Pay frequency.""" + r"""Pay frequency. + + Values: + COMPENSATION_UNIT_UNSPECIFIED (0): + Default value. + HOURLY (1): + Hourly. + DAILY (2): + Daily. + WEEKLY (3): + Weekly + MONTHLY (4): + Monthly. + YEARLY (5): + Yearly. + ONE_TIME (6): + One time. + OTHER_COMPENSATION_UNIT (7): + Other compensation units. + """ COMPENSATION_UNIT_UNSPECIFIED = 0 HOURLY = 1 DAILY = 2 @@ -803,7 +1246,33 @@ class BatchOperationMetadata(proto.Message): """ class State(proto.Enum): - r"""""" + r""" + + Values: + STATE_UNSPECIFIED (0): + Default value. + INITIALIZING (1): + The batch operation is being prepared for + processing. + PROCESSING (2): + The batch operation is actively being + processed. + SUCCEEDED (3): + The batch operation is processed, and at + least one item has been successfully processed. + FAILED (4): + The batch operation is done and no item has + been successfully processed. + CANCELLING (5): + The batch operation is in the process of cancelling after + [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] + is called. + CANCELLED (6): + The batch operation is done after + [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] + is called. Any items processed before cancelling are + returned in the response. + """ STATE_UNSPECIFIED = 0 INITIALIZING = 1 PROCESSING = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/completion_service.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/completion_service.py index f0efbbf0d1ec..dfd7d7bbe9be 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/completion_service.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/completion_service.py @@ -67,13 +67,56 @@ class CompleteQueryRequest(proto.Message): """ class CompletionScope(proto.Enum): - r"""Enum to specify the scope of completion.""" + r"""Enum to specify the scope of completion. + + Values: + COMPLETION_SCOPE_UNSPECIFIED (0): + Default value. + TENANT (1): + Suggestions are based only on the data + provided by the client. + PUBLIC (2): + Suggestions are based on all jobs data in the + system that's visible to the client + """ COMPLETION_SCOPE_UNSPECIFIED = 0 TENANT = 1 PUBLIC = 2 class CompletionType(proto.Enum): - r"""Enum to specify auto-completion topics.""" + r"""Enum to specify auto-completion topics. + + Values: + COMPLETION_TYPE_UNSPECIFIED (0): + Default value. + JOB_TITLE (1): + Suggest job titles for jobs autocomplete. + + For + [CompletionType.JOB_TITLE][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.JOB_TITLE] + type, only open jobs with the same + [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes] + are returned. + COMPANY_NAME (2): + Suggest company names for jobs autocomplete. + + For + [CompletionType.COMPANY_NAME][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMPANY_NAME] + type, only companies having open jobs with the same + [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes] + are returned. + COMBINED (3): + Suggest both job titles and company names for jobs + autocomplete. + + For + [CompletionType.COMBINED][google.cloud.talent.v4.CompleteQueryRequest.CompletionType.COMBINED] + type, only open jobs with the same + [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes] + or companies having open jobs with the same + [language_codes][google.cloud.talent.v4.CompleteQueryRequest.language_codes] + are returned. + """ COMPLETION_TYPE_UNSPECIFIED = 0 JOB_TITLE = 1 COMPANY_NAME = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/event.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/event.py index 45cf1481cf9e..6d51df05bdfa 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/event.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/event.py @@ -112,6 +112,112 @@ class JobEvent(proto.Message): class JobEventType(proto.Enum): r"""An enumeration of an event attributed to the behavior of the end user, such as a job seeker. + + Values: + JOB_EVENT_TYPE_UNSPECIFIED (0): + The event is unspecified by other provided + values. + IMPRESSION (1): + The job seeker or other entity interacting + with the service has had a job rendered in their + view, such as in a list of search results in a + compressed or clipped format. This event is + typically associated with the viewing of a jobs + list on a single page by a job seeker. + VIEW (2): + The job seeker, or other entity interacting with the + service, has viewed the details of a job, including the full + description. This event doesn't apply to the viewing a + snippet of a job appearing as a part of the job search + results. Viewing a snippet is associated with an + [impression][google.cloud.talent.v4.JobEvent.JobEventType.IMPRESSION]). + VIEW_REDIRECT (3): + The job seeker or other entity interacting + with the service performed an action to view a + job and was redirected to a different website + for job. + APPLICATION_START (4): + The job seeker or other entity interacting + with the service began the process or + demonstrated the intention of applying for a + job. + APPLICATION_FINISH (5): + The job seeker or other entity interacting + with the service submitted an application for a + job. + APPLICATION_QUICK_SUBMISSION (6): + The job seeker or other entity interacting with the service + submitted an application for a job with a single click + without entering information. If a job seeker performs this + action, send only this event to the service. Do not also + send + [JobEventType.APPLICATION_START][google.cloud.talent.v4.JobEvent.JobEventType.APPLICATION_START] + or + [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4.JobEvent.JobEventType.APPLICATION_FINISH] + events. + APPLICATION_REDIRECT (7): + The job seeker or other entity interacting + with the service performed an action to apply to + a job and was redirected to a different website + to complete the application. + APPLICATION_START_FROM_SEARCH (8): + The job seeker or other entity interacting + with the service began the process or + demonstrated the intention of applying for a job + from the search results page without viewing the + details of the job posting. If sending this + event, JobEventType.VIEW event shouldn't be + sent. + APPLICATION_REDIRECT_FROM_SEARCH (9): + The job seeker, or other entity interacting with the + service, performs an action with a single click from the + search results page to apply to a job (without viewing the + details of the job posting), and is redirected to a + different website to complete the application. If a + candidate performs this action, send only this event to the + service. Do not also send + [JobEventType.APPLICATION_START][google.cloud.talent.v4.JobEvent.JobEventType.APPLICATION_START], + [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4.JobEvent.JobEventType.APPLICATION_FINISH] + or + [JobEventType.VIEW][google.cloud.talent.v4.JobEvent.JobEventType.VIEW] + events. + APPLICATION_COMPANY_SUBMIT (10): + This event should be used when a company + submits an application on behalf of a job + seeker. This event is intended for use by + staffing agencies attempting to place + candidates. + BOOKMARK (11): + The job seeker or other entity interacting + with the service demonstrated an interest in a + job by bookmarking or saving it. + NOTIFICATION (12): + The job seeker or other entity interacting + with the service was sent a notification, such + as an email alert or device notification, + containing one or more jobs listings generated + by the service. + HIRED (13): + The job seeker or other entity interacting + with the service was employed by the hiring + entity (employer). Send this event only if the + job seeker was hired through an application that + was initiated by a search conducted through the + Cloud Talent Solution service. + SENT_CV (14): + A recruiter or staffing agency submitted an + application on behalf of the candidate after + interacting with the service to identify a + suitable job posting. + INTERVIEW_GRANTED (15): + The entity interacting with the service (for + example, the job seeker), was granted an initial + interview by the hiring entity (employer). This + event should only be sent if the job seeker was + granted an interview as part of an application + that was initiated by a search conducted through + / recommendation provided by the Cloud Talent + Solution service. """ JOB_EVENT_TYPE_UNSPECIFIED = 0 IMPRESSION = 1 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/filters.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/filters.py index 456445f1c7ae..8f5f085468a6 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/filters.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/filters.py @@ -342,7 +342,21 @@ class LocationFilter(proto.Message): """ class TelecommutePreference(proto.Enum): - r"""Specify whether to include telecommute jobs.""" + r"""Specify whether to include telecommute jobs. + + Values: + TELECOMMUTE_PREFERENCE_UNSPECIFIED (0): + Default value if the telecommute preference + isn't specified. + TELECOMMUTE_EXCLUDED (1): + Deprecated: Ignore telecommute status of jobs. Use + TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute + jobs. + TELECOMMUTE_ALLOWED (2): + Allow telecommute jobs. + TELECOMMUTE_JOBS_EXCLUDED (3): + Exclude telecommute jobs. + """ TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0 TELECOMMUTE_EXCLUDED = 1 TELECOMMUTE_ALLOWED = 2 @@ -389,7 +403,54 @@ class CompensationFilter(proto.Message): """ class FilterType(proto.Enum): - r"""Specify the type of filtering.""" + r"""Specify the type of filtering. + + Values: + FILTER_TYPE_UNSPECIFIED (0): + Filter type unspecified. Position holder, + INVALID, should never be used. + UNIT_ONLY (1): + Filter by ``base compensation entry's`` unit. A job is a + match if and only if the job contains a base + CompensationEntry and the base CompensationEntry's unit + matches provided + [units][google.cloud.talent.v4.CompensationFilter.units]. + Populate one or more + [units][google.cloud.talent.v4.CompensationFilter.units]. + + See + [CompensationInfo.CompensationEntry][google.cloud.talent.v4.CompensationInfo.CompensationEntry] + for definition of base compensation entry. + UNIT_AND_AMOUNT (2): + Filter by ``base compensation entry's`` unit and amount / + range. A job is a match if and only if the job contains a + base CompensationEntry, and the base entry's unit matches + provided + [CompensationUnit][google.cloud.talent.v4.CompensationInfo.CompensationUnit] + and amount or range overlaps with provided + [CompensationRange][google.cloud.talent.v4.CompensationInfo.CompensationRange]. + + See + [CompensationInfo.CompensationEntry][google.cloud.talent.v4.CompensationInfo.CompensationEntry] + for definition of base compensation entry. + + Set exactly one + [units][google.cloud.talent.v4.CompensationFilter.units] and + populate + [range][google.cloud.talent.v4.CompensationFilter.range]. + ANNUALIZED_BASE_AMOUNT (3): + Filter by annualized base compensation amount and + ``base compensation entry's`` unit. Populate + [range][google.cloud.talent.v4.CompensationFilter.range] and + zero or more + [units][google.cloud.talent.v4.CompensationFilter.units]. + ANNUALIZED_TOTAL_AMOUNT (4): + Filter by annualized total compensation amount and + ``base compensation entry's`` unit . Populate + [range][google.cloud.talent.v4.CompensationFilter.range] and + zero or more + [units][google.cloud.talent.v4.CompensationFilter.units]. + """ FILTER_TYPE_UNSPECIFIED = 0 UNIT_ONLY = 1 UNIT_AND_AMOUNT = 2 @@ -464,7 +525,18 @@ class CommuteFilter(proto.Message): """ class RoadTraffic(proto.Enum): - r"""The traffic density to use when calculating commute time.""" + r"""The traffic density to use when calculating commute time. + + Values: + ROAD_TRAFFIC_UNSPECIFIED (0): + Road traffic situation isn't specified. + TRAFFIC_FREE (1): + Optimal commute time without considering any + traffic impact. + BUSY_HOUR (2): + Commute time calculation takes in account the + peak traffic impact. + """ ROAD_TRAFFIC_UNSPECIFIED = 0 TRAFFIC_FREE = 1 BUSY_HOUR = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/job_service.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/job_service.py index cb0ee868fd0b..1304634c4777 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/job_service.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/job_service.py @@ -52,6 +52,37 @@ class JobView(proto.Enum): or [ListJobsResponse.jobs][google.cloud.talent.v4.ListJobsResponse.jobs] fields. + + Values: + JOB_VIEW_UNSPECIFIED (0): + Default value. + JOB_VIEW_ID_ONLY (1): + A ID only view of job, with following attributes: + [Job.name][google.cloud.talent.v4.Job.name], + [Job.requisition_id][google.cloud.talent.v4.Job.requisition_id], + [Job.language_code][google.cloud.talent.v4.Job.language_code]. + JOB_VIEW_MINIMAL (2): + A minimal view of the job, with the following attributes: + [Job.name][google.cloud.talent.v4.Job.name], + [Job.requisition_id][google.cloud.talent.v4.Job.requisition_id], + [Job.title][google.cloud.talent.v4.Job.title], + [Job.company][google.cloud.talent.v4.Job.company], + [Job.DerivedInfo.locations][google.cloud.talent.v4.Job.DerivedInfo.locations], + [Job.language_code][google.cloud.talent.v4.Job.language_code]. + JOB_VIEW_SMALL (3): + A small view of the job, with the following attributes in + the search results: + [Job.name][google.cloud.talent.v4.Job.name], + [Job.requisition_id][google.cloud.talent.v4.Job.requisition_id], + [Job.title][google.cloud.talent.v4.Job.title], + [Job.company][google.cloud.talent.v4.Job.company], + [Job.DerivedInfo.locations][google.cloud.talent.v4.Job.DerivedInfo.locations], + [Job.visibility][google.cloud.talent.v4.Job.visibility], + [Job.language_code][google.cloud.talent.v4.Job.language_code], + [Job.description][google.cloud.talent.v4.Job.description]. + JOB_VIEW_FULL (4): + All available attributes are included in the + search results. """ JOB_VIEW_UNSPECIFIED = 0 JOB_VIEW_ID_ONLY = 1 @@ -571,6 +602,24 @@ class SearchJobsRequest(proto.Message): class SearchMode(proto.Enum): r"""A string-represented enumeration of the job search mode. The service operate differently for different modes of service. + + Values: + SEARCH_MODE_UNSPECIFIED (0): + The mode of the search method isn't specified. The default + search behavior is identical to JOB_SEARCH search behavior. + JOB_SEARCH (1): + The job search matches against all jobs, and + featured jobs (jobs with promotionValue > 0) are + not specially handled. + FEATURED_JOB_SEARCH (2): + The job search matches only against featured + jobs (jobs with a promotionValue > 0). This + method doesn't return any jobs having a + promotionValue <= 0. The search results order is + determined by the promotionValue (jobs with a + higher promotionValue are returned higher up in + the search results), with relevance being used + as a tiebreaker. """ SEARCH_MODE_UNSPECIFIED = 0 JOB_SEARCH = 1 @@ -589,6 +638,37 @@ class DiversificationLevel(proto.Enum): latency might be lower but we can't guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned. + + Values: + DIVERSIFICATION_LEVEL_UNSPECIFIED (0): + The diversification level isn't specified. + DISABLED (1): + Disables diversification. Jobs that would + normally be pushed to the last page would not + have their positions altered. This may result in + highly similar jobs appearing in sequence in the + search results. + SIMPLE (2): + Default diversifying behavior. The result + list is ordered so that highly similar results + are pushed to the end of the last page of search + results. + ONE_PER_COMPANY (3): + Only one job from the same company will be + shown at once, other jobs under same company are + pushed to the end of the last page of search + result. + TWO_PER_COMPANY (4): + Similar to ONE_PER_COMPANY, but it allows at most two jobs + in the same company to be shown at once, the other jobs + under same company are pushed to the end of the last page of + search result. + DIVERSIFY_BY_LOOSER_SIMILARITY (5): + The result list is ordered such that somewhat + similar results are pushed to the end of the + last page of the search results. This option is + recommended if SIMPLE diversification does not + diversify enough. """ DIVERSIFICATION_LEVEL_UNSPECIFIED = 0 DISABLED = 1 @@ -615,6 +695,27 @@ class KeywordMatchMode(proto.Enum): if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. + + Values: + KEYWORD_MATCH_MODE_UNSPECIFIED (0): + The keyword match option isn't specified. Defaults to + [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL] + behavior. + KEYWORD_MATCH_DISABLED (1): + Disables keyword matching. + KEYWORD_MATCH_ALL (2): + Enable keyword matching over + [Job.title][google.cloud.talent.v4.Job.title], + [Job.description][google.cloud.talent.v4.Job.description], + [Job.company_display_name][google.cloud.talent.v4.Job.company_display_name], + [Job.addresses][google.cloud.talent.v4.Job.addresses], + [Job.qualifications][google.cloud.talent.v4.Job.qualifications], + and keyword searchable + [Job.custom_attributes][google.cloud.talent.v4.Job.custom_attributes] + fields. + KEYWORD_MATCH_TITLE_ONLY (3): + Only enable keyword matching over + [Job.title][google.cloud.talent.v4.Job.title]. """ KEYWORD_MATCH_MODE_UNSPECIFIED = 0 KEYWORD_MATCH_DISABLED = 1 @@ -663,6 +764,41 @@ class CustomRankingInfo(proto.Message): class ImportanceLevel(proto.Enum): r"""The importance level for [CustomRankingInfo.ranking_expression][google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ranking_expression]. + + Values: + IMPORTANCE_LEVEL_UNSPECIFIED (0): + Default value if the importance level isn't + specified. + NONE (1): + The given ranking expression is of None + importance, existing relevance score (determined + by API algorithm) dominates job's final ranking + position. + LOW (2): + The given ranking expression is of Low + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + MILD (3): + The given ranking expression is of Mild + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + MEDIUM (4): + The given ranking expression is of Medium + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + HIGH (5): + The given ranking expression is of High + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + EXTREME (6): + The given ranking expression is of Extreme + importance, and dominates job's final ranking + position with existing relevance score + (determined by API algorithm) ignored. """ IMPORTANCE_LEVEL_UNSPECIFIED = 0 NONE = 1 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4/types/tenant.py b/packages/google-cloud-talent/google/cloud/talent_v4/types/tenant.py index acf6d7527f4e..7f4456baf088 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4/types/tenant.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4/types/tenant.py @@ -43,6 +43,7 @@ class Tenant(proto.Message): external_id (str): Required. Client side tenant identifier, used to uniquely identify the tenant. + The maximum number of allowed characters is 255. """ diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/company_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/company_service/client.py index 036091f65bcd..8f87deedc575 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/company_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/company_service/client.py @@ -1019,7 +1019,7 @@ def sample_list_companies(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "CompanyServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/completion/client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/completion/client.py index 200c43cf6980..cd578f73bea8 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/completion/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/completion/client.py @@ -522,7 +522,7 @@ def sample_complete_query(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "CompletionClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/event_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/event_service/client.py index 4ae64151b14e..0e69ebd08cdc 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/event_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/event_service/client.py @@ -579,7 +579,7 @@ def sample_create_client_event(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "EventServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/async_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/async_client.py index 31dac73def26..2ed5e07433f9 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/async_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/async_client.py @@ -426,7 +426,9 @@ async def sample_batch_create_jobs(): google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or + The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] + or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] @@ -795,7 +797,9 @@ async def sample_batch_update_jobs(): google.api_core.operation_async.AsyncOperation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or + The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] + or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/client.py index fd2d7b9b30f3..3b540142cbc1 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/job_service/client.py @@ -677,7 +677,9 @@ def sample_batch_create_jobs(): google.api_core.operation.Operation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or + The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] + or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] @@ -1036,7 +1038,9 @@ def sample_batch_update_jobs(): google.api_core.operation.Operation: An object representing a long-running operation. - The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] or + The result type for the operation will be :class:`google.cloud.talent_v4beta1.types.JobOperationResult` The result of + [JobService.BatchCreateJobs][google.cloud.talent.v4beta1.JobService.BatchCreateJobs] + or [JobService.BatchUpdateJobs][google.cloud.talent.v4beta1.JobService.BatchUpdateJobs] APIs. It's used to replace [google.longrunning.Operation.response][google.longrunning.Operation.response] @@ -1668,7 +1672,7 @@ def sample_search_jobs_for_alert(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "JobServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/tenant_service/client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/tenant_service/client.py index 53f493dd696d..4e7466d17c97 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/tenant_service/client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/services/tenant_service/client.py @@ -995,7 +995,7 @@ def sample_list_tenants(): # Done; return the response. return response - def __enter__(self): + def __enter__(self) -> "TenantServiceClient": return self def __exit__(self, type, value, traceback): diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/common.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/common.py index 10759914f9e5..f58d3d729d91 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/common.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/common.py @@ -49,7 +49,30 @@ class CompanySize(proto.Enum): - r"""An enum that represents the size of the company.""" + r"""An enum that represents the size of the company. + + Values: + COMPANY_SIZE_UNSPECIFIED (0): + Default value if the size isn't specified. + MINI (1): + The company has less than 50 employees. + SMALL (2): + The company has between 50 and 99 employees. + SMEDIUM (3): + The company has between 100 and 499 + employees. + MEDIUM (4): + The company has between 500 and 999 + employees. + BIG (5): + The company has between 1,000 and 4,999 + employees. + BIGGER (6): + The company has between 5,000 and 9,999 + employees. + GIANT (7): + The company has 10,000 or more employees. + """ COMPANY_SIZE_UNSPECIFIED = 0 MINI = 1 SMALL = 2 @@ -63,6 +86,43 @@ class CompanySize(proto.Enum): class JobBenefit(proto.Enum): r"""An enum that represents employee benefits included with the job. + + Values: + JOB_BENEFIT_UNSPECIFIED (0): + Default value if the type isn't specified. + CHILD_CARE (1): + The job includes access to programs that + support child care, such as daycare. + DENTAL (2): + The job includes dental services covered by a + dental insurance plan. + DOMESTIC_PARTNER (3): + The job offers specific benefits to domestic + partners. + FLEXIBLE_HOURS (4): + The job allows for a flexible work schedule. + MEDICAL (5): + The job includes health services covered by a + medical insurance plan. + LIFE_INSURANCE (6): + The job includes a life insurance plan + provided by the employer or available for + purchase by the employee. + PARENTAL_LEAVE (7): + The job allows for a leave of absence to a + parent to care for a newborn child. + RETIREMENT_PLAN (8): + The job includes a workplace retirement plan + provided by the employer or available for + purchase by the employee. + SICK_DAYS (9): + The job allows for paid time off due to + illness. + VACATION (10): + The job includes paid time off for vacation. + VISION (11): + The job includes vision services covered by a + vision insurance plan. """ JOB_BENEFIT_UNSPECIFIED = 0 CHILD_CARE = 1 @@ -81,6 +141,62 @@ class JobBenefit(proto.Enum): class DegreeType(proto.Enum): r"""Educational degree level defined in International Standard Classification of Education (ISCED). + + Values: + DEGREE_TYPE_UNSPECIFIED (0): + Default value. Represents no degree, or early + childhood education. Maps to ISCED code 0. + Ex) Kindergarten + PRIMARY_EDUCATION (1): + Primary education which is typically the + first stage of compulsory education. ISCED code + 1. Ex) Elementary school + LOWER_SECONDARY_EDUCATION (2): + Lower secondary education; First stage of + secondary education building on primary + education, typically with a more + subject-oriented curriculum. ISCED code 2. + Ex) Middle school + UPPER_SECONDARY_EDUCATION (3): + Middle education; Second/final stage of + secondary education preparing for tertiary + education and/or providing skills relevant to + employment. Usually with an increased range of + subject options and streams. ISCED code 3. + Ex) High school + ADULT_REMEDIAL_EDUCATION (4): + Adult Remedial Education; Programmes + providing learning experiences that build on + secondary education and prepare for labour + market entry and/or tertiary education. The + content is broader than secondary but not as + complex as tertiary education. ISCED code 4. + ASSOCIATES_OR_EQUIVALENT (5): + Associate's or equivalent; Short first + tertiary programmes that are typically + practically-based, occupationally-specific and + prepare for labour market entry. These + programmes may also provide a pathway to other + tertiary programmes. ISCED code 5. + BACHELORS_OR_EQUIVALENT (6): + Bachelor's or equivalent; Programmes designed + to provide intermediate academic and/or + professional knowledge, skills and competencies + leading to a first tertiary degree or equivalent + qualification. ISCED code 6. + MASTERS_OR_EQUIVALENT (7): + Master's or equivalent; Programmes designed + to provide advanced academic and/or professional + knowledge, skills and competencies leading to a + second tertiary degree or equivalent + qualification. ISCED code 7. + DOCTORAL_OR_EQUIVALENT (8): + Doctoral or equivalent; Programmes designed + primarily to lead to an advanced research + qualification, usually concluding with the + submission and defense of a substantive + dissertation of publishable quality based on + original research. ISCED code 8. """ DEGREE_TYPE_UNSPECIFIED = 0 PRIMARY_EDUCATION = 1 @@ -94,7 +210,54 @@ class DegreeType(proto.Enum): class EmploymentType(proto.Enum): - r"""An enum that represents the employment type of a job.""" + r"""An enum that represents the employment type of a job. + + Values: + EMPLOYMENT_TYPE_UNSPECIFIED (0): + The default value if the employment type + isn't specified. + FULL_TIME (1): + The job requires working a number of hours + that constitute full time employment, typically + 40 or more hours per week. + PART_TIME (2): + The job entails working fewer hours than a + full time job, typically less than 40 hours a + week. + CONTRACTOR (3): + The job is offered as a contracted, as + opposed to a salaried employee, position. + CONTRACT_TO_HIRE (4): + 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. + TEMPORARY (5): + The job is offered as a temporary employment + opportunity, usually a short-term engagement. + INTERN (6): + The job is a fixed-term opportunity for + students or entry-level job seekers to obtain + on-the-job training, typically offered as a + summer position. + VOLUNTEER (7): + The is an opportunity for an individual to + volunteer, where there's no expectation of + compensation for the provided services. + PER_DIEM (8): + The job requires an employee to work on an + as-needed basis with a flexible schedule. + FLY_IN_FLY_OUT (9): + The job involves employing people in remote + areas and flying them temporarily to the work + site instead of relocating employees and their + families permanently. + OTHER_EMPLOYMENT_TYPE (10): + The job does not fit any of the other listed + types. + """ EMPLOYMENT_TYPE_UNSPECIFIED = 0 FULL_TIME = 1 PART_TIME = 2 @@ -111,6 +274,28 @@ class EmploymentType(proto.Enum): class JobLevel(proto.Enum): r"""An enum that represents the required experience level required for the job. + + Values: + JOB_LEVEL_UNSPECIFIED (0): + The default value if the level isn't + specified. + ENTRY_LEVEL (1): + Entry-level individual contributors, + typically with less than 2 years of experience + in a similar role. Includes interns. + EXPERIENCED (2): + Experienced individual contributors, + typically with 2+ years of experience in a + similar role. + MANAGER (3): + Entry- to mid-level managers responsible for + managing a team of people. + DIRECTOR (4): + Senior-level managers responsible for + managing teams of managers. + EXECUTIVE (5): + Executive-level managers and above, including + C-level positions. """ JOB_LEVEL_UNSPECIFIED = 0 ENTRY_LEVEL = 1 @@ -125,6 +310,94 @@ class JobCategory(proto.Enum): of specific role. This value is different than the "industry" associated with a role, which is related to the categorization of the company listing the job. + + Values: + JOB_CATEGORY_UNSPECIFIED (0): + The default value if the category isn't + specified. + ACCOUNTING_AND_FINANCE (1): + An accounting and finance job, such as an + Accountant. + ADMINISTRATIVE_AND_OFFICE (2): + An administrative and office job, such as an + Administrative Assistant. + ADVERTISING_AND_MARKETING (3): + An advertising and marketing job, such as + Marketing Manager. + ANIMAL_CARE (4): + An animal care job, such as Veterinarian. + ART_FASHION_AND_DESIGN (5): + An art, fashion, or design job, such as + Designer. + BUSINESS_OPERATIONS (6): + A business operations job, such as Business + Operations Manager. + CLEANING_AND_FACILITIES (7): + A cleaning and facilities job, such as + Custodial Staff. + COMPUTER_AND_IT (8): + A computer and IT job, such as Systems + Administrator. + CONSTRUCTION (9): + A construction job, such as General Laborer. + CUSTOMER_SERVICE (10): + A customer service job, such s Cashier. + EDUCATION (11): + An education job, such as School Teacher. + ENTERTAINMENT_AND_TRAVEL (12): + An entertainment and travel job, such as + Flight Attendant. + FARMING_AND_OUTDOORS (13): + A farming or outdoor job, such as Park + Ranger. + HEALTHCARE (14): + A healthcare job, such as Registered Nurse. + HUMAN_RESOURCES (15): + A human resources job, such as Human + Resources Director. + INSTALLATION_MAINTENANCE_AND_REPAIR (16): + An installation, maintenance, or repair job, + such as Electrician. + LEGAL (17): + A legal job, such as Law Clerk. + MANAGEMENT (18): + A management job, often used in conjunction + with another category, such as Store Manager. + MANUFACTURING_AND_WAREHOUSE (19): + A manufacturing or warehouse job, such as + Assembly Technician. + MEDIA_COMMUNICATIONS_AND_WRITING (20): + A media, communications, or writing job, such + as Media Relations. + OIL_GAS_AND_MINING (21): + An oil, gas or mining job, such as Offshore + Driller. + PERSONAL_CARE_AND_SERVICES (22): + A personal care and services job, such as + Hair Stylist. + PROTECTIVE_SERVICES (23): + A protective services job, such as Security + Guard. + REAL_ESTATE (24): + A real estate job, such as Buyer's Agent. + RESTAURANT_AND_HOSPITALITY (25): + A restaurant and hospitality job, such as + Restaurant Server. + SALES_AND_RETAIL (26): + A sales and/or retail job, such Sales + Associate. + SCIENCE_AND_ENGINEERING (27): + A science and engineering job, such as Lab + Technician. + SOCIAL_SERVICES_AND_NON_PROFIT (28): + A social services or non-profit job, such as + Case Worker. + SPORTS_FITNESS_AND_RECREATION (29): + A sports, fitness, or recreation job, such as + Personal Trainer. + TRANSPORTATION_AND_LOGISTICS (30): + A transportation or logistics job, such as + Truck Driver. """ JOB_CATEGORY_UNSPECIFIED = 0 ACCOUNTING_AND_FINANCE = 1 @@ -164,6 +437,39 @@ class PostingRegion(proto.Enum): cases, job postings don't need to specify a region. If a region is given, jobs are eligible for searches in the specified region. + + Values: + POSTING_REGION_UNSPECIFIED (0): + If the region is unspecified, the job is only returned if it + matches the + [LocationFilter][google.cloud.talent.v4beta1.LocationFilter]. + ADMINISTRATIVE_AREA (1): + 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". + + Administrative area refers to top-level administrative + subdivision of this country. For example, US state, IT + region, UK constituent nation and JP prefecture. + NATION (2): + 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'. + TELECOMMUTE (3): + Job allows employees to work remotely + (telecommute). If locations are provided with + this value, the job is considered as having a + location, but telecommuting is allowed. """ POSTING_REGION_UNSPECIFIED = 0 ADMINISTRATIVE_AREA = 1 @@ -174,6 +480,20 @@ class PostingRegion(proto.Enum): class Visibility(proto.Enum): r"""Deprecated. All resources are only visible to the owner. An enum that represents who has view access to the resource. + + Values: + VISIBILITY_UNSPECIFIED (0): + Default value. + ACCOUNT_ONLY (1): + The resource is only visible to the GCP + account who owns it. + SHARED_WITH_GOOGLE (2): + The resource is visible to the owner and may + be visible to other applications and processes + at Google. + SHARED_WITH_PUBLIC (3): + The resource is visible to the owner and may + be visible to all other API clients. """ _pb_options = {"deprecated": True} VISIBILITY_UNSPECIFIED = 0 @@ -187,6 +507,16 @@ class HtmlSanitization(proto.Enum): for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields. + + Values: + HTML_SANITIZATION_UNSPECIFIED (0): + Default value. + HTML_SANITIZATION_DISABLED (1): + Disables sanitization on HTML input. + SIMPLE_FORMATTING_ONLY (2): + Sanitizes HTML input, only accepts bold, + italic, ordered list, and unordered list markup + tags. """ HTML_SANITIZATION_UNSPECIFIED = 0 HTML_SANITIZATION_DISABLED = 1 @@ -194,7 +524,24 @@ class HtmlSanitization(proto.Enum): class CommuteMethod(proto.Enum): - r"""Method for commute.""" + r"""Method for commute. + + Values: + COMMUTE_METHOD_UNSPECIFIED (0): + Commute method isn't specified. + DRIVING (1): + Commute time is calculated based on driving + time. + TRANSIT (2): + Commute time is calculated based on public + transit including bus, metro, subway, and so on. + WALKING (3): + Commute time is calculated based on walking + time. + CYCLING (4): + Commute time is calculated based on biking + time. + """ COMMUTE_METHOD_UNSPECIFIED = 0 DRIVING = 1 TRANSIT = 2 @@ -256,7 +603,39 @@ class Location(proto.Message): """ class LocationType(proto.Enum): - r"""An enum which represents the type of a location.""" + r"""An enum which represents the type of a location. + + Values: + LOCATION_TYPE_UNSPECIFIED (0): + Default value if the type isn't specified. + COUNTRY (1): + A country level location. + ADMINISTRATIVE_AREA (2): + A state or equivalent level location. + SUB_ADMINISTRATIVE_AREA (3): + A county or equivalent level location. + LOCALITY (4): + A city or equivalent level location. + POSTAL_CODE (5): + A postal code level location. + SUB_LOCALITY (6): + A sublocality is a subdivision of a locality, + for example a city borough, ward, or + arrondissement. Sublocalities are usually + recognized by a local political authority. For + example, Manhattan and Brooklyn are recognized + as boroughs by the City of New York, and are + therefore modeled as sublocalities. + SUB_LOCALITY_1 (7): + A district or equivalent level location. + SUB_LOCALITY_2 (8): + A smaller district or equivalent level + display. + NEIGHBORHOOD (9): + A neighborhood level location. + STREET_ADDRESS (10): + A street address level location. + """ LOCATION_TYPE_UNSPECIFIED = 0 COUNTRY = 1 ADMINISTRATIVE_AREA = 2 @@ -421,6 +800,25 @@ class DeviceInfo(proto.Message): class DeviceType(proto.Enum): r"""An enumeration describing an API access portal and exposure mechanism. + + Values: + DEVICE_TYPE_UNSPECIFIED (0): + The device type isn't specified. + WEB (1): + A desktop web browser, such as, Chrome, + Firefox, Safari, or Internet Explorer) + MOBILE_WEB (2): + A mobile device web browser, such as a phone + or tablet with a Chrome browser. + ANDROID (3): + An Android device native application. + IOS (4): + An iOS device native application. + BOT (5): + A bot, as opposed to a device operated by + human beings, such as a web crawler. + OTHER (6): + Other devices types. """ DEVICE_TYPE_UNSPECIFIED = 0 WEB = 1 @@ -606,6 +1004,30 @@ class CompensationType(proto.Enum): and then further clarified in [CompensationEntry.description][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.description] field. + + Values: + COMPENSATION_TYPE_UNSPECIFIED (0): + Default value. + BASE (1): + Base compensation: Refers to the fixed amount + of money paid to an employee by an employer in + return for work performed. Base compensation + does not include benefits, bonuses or any other + potential compensation from an employer. + BONUS (2): + Bonus. + SIGNING_BONUS (3): + Signing bonus. + EQUITY (4): + Equity. + PROFIT_SHARING (5): + Profit sharing. + COMMISSIONS (6): + Commission. + TIPS (7): + Tips. + OTHER_COMPENSATION_TYPE (8): + Other compensation type. """ COMPENSATION_TYPE_UNSPECIFIED = 0 BASE = 1 @@ -618,7 +1040,26 @@ class CompensationType(proto.Enum): OTHER_COMPENSATION_TYPE = 8 class CompensationUnit(proto.Enum): - r"""Pay frequency.""" + r"""Pay frequency. + + Values: + COMPENSATION_UNIT_UNSPECIFIED (0): + Default value. + HOURLY (1): + Hourly. + DAILY (2): + Daily. + WEEKLY (3): + Weekly + MONTHLY (4): + Monthly. + YEARLY (5): + Yearly. + ONE_TIME (6): + One time. + OTHER_COMPENSATION_UNIT (7): + Other compensation units. + """ COMPENSATION_UNIT_UNSPECIFIED = 0 HOURLY = 1 DAILY = 2 @@ -800,7 +1241,33 @@ class BatchOperationMetadata(proto.Message): """ class State(proto.Enum): - r"""""" + r""" + + Values: + STATE_UNSPECIFIED (0): + Default value. + INITIALIZING (1): + The batch operation is being prepared for + processing. + PROCESSING (2): + The batch operation is actively being + processed. + SUCCEEDED (3): + The batch operation is processed, and at + least one item has been successfully processed. + FAILED (4): + The batch operation is done and no item has + been successfully processed. + CANCELLING (5): + The batch operation is in the process of cancelling after + [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] + is called. + CANCELLED (6): + The batch operation is done after + [google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] + is called. Any items processed before cancelling are + returned in the response. + """ STATE_UNSPECIFIED = 0 INITIALIZING = 1 PROCESSING = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/completion_service.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/completion_service.py index ed6fbe0ccd40..aa70445502db 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/completion_service.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/completion_service.py @@ -73,13 +73,56 @@ class CompleteQueryRequest(proto.Message): """ class CompletionScope(proto.Enum): - r"""Enum to specify the scope of completion.""" + r"""Enum to specify the scope of completion. + + Values: + COMPLETION_SCOPE_UNSPECIFIED (0): + Default value. + TENANT (1): + Suggestions are based only on the data + provided by the client. + PUBLIC (2): + Suggestions are based on all jobs data in the + system that's visible to the client + """ COMPLETION_SCOPE_UNSPECIFIED = 0 TENANT = 1 PUBLIC = 2 class CompletionType(proto.Enum): - r"""Enum to specify auto-completion topics.""" + r"""Enum to specify auto-completion topics. + + Values: + COMPLETION_TYPE_UNSPECIFIED (0): + Default value. + JOB_TITLE (1): + Suggest job titles for jobs autocomplete. + + For + [CompletionType.JOB_TITLE][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.JOB_TITLE] + type, only open jobs with the same + [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] + are returned. + COMPANY_NAME (2): + Suggest company names for jobs autocomplete. + + For + [CompletionType.COMPANY_NAME][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMPANY_NAME] + type, only companies having open jobs with the same + [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] + are returned. + COMBINED (3): + Suggest both job titles and company names for jobs + autocomplete. + + For + [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED] + type, only open jobs with the same + [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] + or companies having open jobs with the same + [language_codes][google.cloud.talent.v4beta1.CompleteQueryRequest.language_codes] + are returned. + """ COMPLETION_TYPE_UNSPECIFIED = 0 JOB_TITLE = 1 COMPANY_NAME = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/event.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/event.py index d439e00bbbec..e6a4c43d35d0 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/event.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/event.py @@ -120,6 +120,112 @@ class JobEvent(proto.Message): class JobEventType(proto.Enum): r"""An enumeration of an event attributed to the behavior of the end user, such as a job seeker. + + Values: + JOB_EVENT_TYPE_UNSPECIFIED (0): + The event is unspecified by other provided + values. + IMPRESSION (1): + The job seeker or other entity interacting + with the service has had a job rendered in their + view, such as in a list of search results in a + compressed or clipped format. This event is + typically associated with the viewing of a jobs + list on a single page by a job seeker. + VIEW (2): + The job seeker, or other entity interacting with the + service, has viewed the details of a job, including the full + description. This event doesn't apply to the viewing a + snippet of a job appearing as a part of the job search + results. Viewing a snippet is associated with an + [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION]). + VIEW_REDIRECT (3): + The job seeker or other entity interacting + with the service performed an action to view a + job and was redirected to a different website + for job. + APPLICATION_START (4): + The job seeker or other entity interacting + with the service began the process or + demonstrated the intention of applying for a + job. + APPLICATION_FINISH (5): + The job seeker or other entity interacting + with the service submitted an application for a + job. + APPLICATION_QUICK_SUBMISSION (6): + The job seeker or other entity interacting with the service + submitted an application for a job with a single click + without entering information. If a job seeker performs this + action, send only this event to the service. Do not also + send + [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START] + or + [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] + events. + APPLICATION_REDIRECT (7): + The job seeker or other entity interacting + with the service performed an action to apply to + a job and was redirected to a different website + to complete the application. + APPLICATION_START_FROM_SEARCH (8): + The job seeker or other entity interacting + with the service began the process or + demonstrated the intention of applying for a job + from the search results page without viewing the + details of the job posting. If sending this + event, JobEventType.VIEW event shouldn't be + sent. + APPLICATION_REDIRECT_FROM_SEARCH (9): + The job seeker, or other entity interacting with the + service, performs an action with a single click from the + search results page to apply to a job (without viewing the + details of the job posting), and is redirected to a + different website to complete the application. If a + candidate performs this action, send only this event to the + service. Do not also send + [JobEventType.APPLICATION_START][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_START], + [JobEventType.APPLICATION_FINISH][google.cloud.talent.v4beta1.JobEvent.JobEventType.APPLICATION_FINISH] + or + [JobEventType.VIEW][google.cloud.talent.v4beta1.JobEvent.JobEventType.VIEW] + events. + APPLICATION_COMPANY_SUBMIT (10): + This event should be used when a company + submits an application on behalf of a job + seeker. This event is intended for use by + staffing agencies attempting to place + candidates. + BOOKMARK (11): + The job seeker or other entity interacting + with the service demonstrated an interest in a + job by bookmarking or saving it. + NOTIFICATION (12): + The job seeker or other entity interacting + with the service was sent a notification, such + as an email alert or device notification, + containing one or more jobs listings generated + by the service. + HIRED (13): + The job seeker or other entity interacting + with the service was employed by the hiring + entity (employer). Send this event only if the + job seeker was hired through an application that + was initiated by a search conducted through the + Cloud Talent Solution service. + SENT_CV (14): + A recruiter or staffing agency submitted an + application on behalf of the candidate after + interacting with the service to identify a + suitable job posting. + INTERVIEW_GRANTED (15): + The entity interacting with the service (for + example, the job seeker), was granted an initial + interview by the hiring entity (employer). This + event should only be sent if the job seeker was + granted an interview as part of an application + that was initiated by a search conducted through + / recommendation provided by the Cloud Talent + Solution service. """ JOB_EVENT_TYPE_UNSPECIFIED = 0 IMPRESSION = 1 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/filters.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/filters.py index 40d9fbae6fd9..8a5a34d8a576 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/filters.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/filters.py @@ -350,7 +350,21 @@ class LocationFilter(proto.Message): """ class TelecommutePreference(proto.Enum): - r"""Specify whether to include telecommute jobs.""" + r"""Specify whether to include telecommute jobs. + + Values: + TELECOMMUTE_PREFERENCE_UNSPECIFIED (0): + Default value if the telecommute preference + isn't specified. + TELECOMMUTE_EXCLUDED (1): + Deprecated: Ignore telecommute status of jobs. Use + TELECOMMUTE_JOBS_EXCLUDED if want to exclude telecommute + jobs. + TELECOMMUTE_ALLOWED (2): + Allow telecommute jobs. + TELECOMMUTE_JOBS_EXCLUDED (3): + Exclude telecommute jobs. + """ TELECOMMUTE_PREFERENCE_UNSPECIFIED = 0 TELECOMMUTE_EXCLUDED = 1 TELECOMMUTE_ALLOWED = 2 @@ -401,7 +415,54 @@ class CompensationFilter(proto.Message): """ class FilterType(proto.Enum): - r"""Specify the type of filtering.""" + r"""Specify the type of filtering. + + Values: + FILTER_TYPE_UNSPECIFIED (0): + Filter type unspecified. Position holder, + INVALID, should never be used. + UNIT_ONLY (1): + Filter by ``base compensation entry's`` unit. A job is a + match if and only if the job contains a base + CompensationEntry and the base CompensationEntry's unit + matches provided + [units][google.cloud.talent.v4beta1.CompensationFilter.units]. + Populate one or more + [units][google.cloud.talent.v4beta1.CompensationFilter.units]. + + See + [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] + for definition of base compensation entry. + UNIT_AND_AMOUNT (2): + Filter by ``base compensation entry's`` unit and amount / + range. A job is a match if and only if the job contains a + base CompensationEntry, and the base entry's unit matches + provided + [CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit] + and amount or range overlaps with provided + [CompensationRange][google.cloud.talent.v4beta1.CompensationInfo.CompensationRange]. + + See + [CompensationInfo.CompensationEntry][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry] + for definition of base compensation entry. + + Set exactly one + [units][google.cloud.talent.v4beta1.CompensationFilter.units] + and populate + [range][google.cloud.talent.v4beta1.CompensationFilter.range]. + ANNUALIZED_BASE_AMOUNT (3): + Filter by annualized base compensation amount and + ``base compensation entry's`` unit. Populate + [range][google.cloud.talent.v4beta1.CompensationFilter.range] + and zero or more + [units][google.cloud.talent.v4beta1.CompensationFilter.units]. + ANNUALIZED_TOTAL_AMOUNT (4): + Filter by annualized total compensation amount and + ``base compensation entry's`` unit . Populate + [range][google.cloud.talent.v4beta1.CompensationFilter.range] + and zero or more + [units][google.cloud.talent.v4beta1.CompensationFilter.units]. + """ FILTER_TYPE_UNSPECIFIED = 0 UNIT_ONLY = 1 UNIT_AND_AMOUNT = 2 @@ -476,7 +537,18 @@ class CommuteFilter(proto.Message): """ class RoadTraffic(proto.Enum): - r"""The traffic density to use when calculating commute time.""" + r"""The traffic density to use when calculating commute time. + + Values: + ROAD_TRAFFIC_UNSPECIFIED (0): + Road traffic situation isn't specified. + TRAFFIC_FREE (1): + Optimal commute time without considering any + traffic impact. + BUSY_HOUR (2): + Commute time calculation takes in account the + peak traffic impact. + """ ROAD_TRAFFIC_UNSPECIFIED = 0 TRAFFIC_FREE = 1 BUSY_HOUR = 2 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/job_service.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/job_service.py index 294729ca2b2b..1a6aaf8d6208 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/job_service.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/job_service.py @@ -49,6 +49,37 @@ class JobView(proto.Enum): or [ListJobsResponse.jobs][google.cloud.talent.v4beta1.ListJobsResponse.jobs] fields. + + Values: + JOB_VIEW_UNSPECIFIED (0): + Default value. + JOB_VIEW_ID_ONLY (1): + A ID only view of job, with following attributes: + [Job.name][google.cloud.talent.v4beta1.Job.name], + [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], + [Job.language_code][google.cloud.talent.v4beta1.Job.language_code]. + JOB_VIEW_MINIMAL (2): + A minimal view of the job, with the following attributes: + [Job.name][google.cloud.talent.v4beta1.Job.name], + [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], + [Job.title][google.cloud.talent.v4beta1.Job.title], + [Job.company][google.cloud.talent.v4beta1.Job.company], + [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], + [Job.language_code][google.cloud.talent.v4beta1.Job.language_code]. + JOB_VIEW_SMALL (3): + A small view of the job, with the following attributes in + the search results: + [Job.name][google.cloud.talent.v4beta1.Job.name], + [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id], + [Job.title][google.cloud.talent.v4beta1.Job.title], + [Job.company][google.cloud.talent.v4beta1.Job.company], + [Job.DerivedInfo.locations][google.cloud.talent.v4beta1.Job.DerivedInfo.locations], + [Job.visibility][google.cloud.talent.v4beta1.Job.visibility], + [Job.language_code][google.cloud.talent.v4beta1.Job.language_code], + [Job.description][google.cloud.talent.v4beta1.Job.description]. + JOB_VIEW_FULL (4): + All available attributes are included in the + search results. """ JOB_VIEW_UNSPECIFIED = 0 JOB_VIEW_ID_ONLY = 1 @@ -619,6 +650,24 @@ class SearchJobsRequest(proto.Message): class SearchMode(proto.Enum): r"""A string-represented enumeration of the job search mode. The service operate differently for different modes of service. + + Values: + SEARCH_MODE_UNSPECIFIED (0): + The mode of the search method isn't specified. The default + search behavior is identical to JOB_SEARCH search behavior. + JOB_SEARCH (1): + The job search matches against all jobs, and + featured jobs (jobs with promotionValue > 0) are + not specially handled. + FEATURED_JOB_SEARCH (2): + The job search matches only against featured + jobs (jobs with a promotionValue > 0). This + method doesn't return any jobs having a + promotionValue <= 0. The search results order is + determined by the promotionValue (jobs with a + higher promotionValue are returned higher up in + the search results), with relevance being used + as a tiebreaker. """ SEARCH_MODE_UNSPECIFIED = 0 JOB_SEARCH = 1 @@ -632,6 +681,25 @@ class DiversificationLevel(proto.Enum): representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results. + + Values: + DIVERSIFICATION_LEVEL_UNSPECIFIED (0): + The diversification level isn't specified. + DISABLED (1): + Disables diversification. Jobs that would + normally be pushed to the last page would not + have their positions altered. This may result in + highly similar jobs appearing in sequence in the + search results. + SIMPLE (2): + Default diversifying behavior. The result + list is ordered so that highly similar results + are pushed to the end of the last page of search + results. If you are using pageToken to page + through the result set, latency might be lower + but we can't guarantee that all results are + returned. If you are using page offset, latency + might be higher but all results are returned. """ DIVERSIFICATION_LEVEL_UNSPECIFIED = 0 DISABLED = 1 @@ -655,6 +723,27 @@ class KeywordMatchMode(proto.Enum): if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests. + + Values: + KEYWORD_MATCH_MODE_UNSPECIFIED (0): + The keyword match option isn't specified. Defaults to + [KeywordMatchMode.KEYWORD_MATCH_ALL][google.cloud.talent.v4beta1.SearchJobsRequest.KeywordMatchMode.KEYWORD_MATCH_ALL] + behavior. + KEYWORD_MATCH_DISABLED (1): + Disables keyword matching. + KEYWORD_MATCH_ALL (2): + Enable keyword matching over + [Job.title][google.cloud.talent.v4beta1.Job.title], + [Job.description][google.cloud.talent.v4beta1.Job.description], + [Job.company_display_name][google.cloud.talent.v4beta1.Job.company_display_name], + [Job.addresses][google.cloud.talent.v4beta1.Job.addresses], + [Job.qualifications][google.cloud.talent.v4beta1.Job.qualifications], + and keyword searchable + [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] + fields. + KEYWORD_MATCH_TITLE_ONLY (3): + Only enable keyword matching over + [Job.title][google.cloud.talent.v4beta1.Job.title]. """ KEYWORD_MATCH_MODE_UNSPECIFIED = 0 KEYWORD_MATCH_DISABLED = 1 @@ -703,6 +792,41 @@ class CustomRankingInfo(proto.Message): class ImportanceLevel(proto.Enum): r"""The importance level for [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression]. + + Values: + IMPORTANCE_LEVEL_UNSPECIFIED (0): + Default value if the importance level isn't + specified. + NONE (1): + The given ranking expression is of None + importance, existing relevance score (determined + by API algorithm) dominates job's final ranking + position. + LOW (2): + The given ranking expression is of Low + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + MILD (3): + The given ranking expression is of Mild + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + MEDIUM (4): + The given ranking expression is of Medium + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + HIGH (5): + The given ranking expression is of High + importance in terms of job's final ranking + position compared to existing relevance score + (determined by API algorithm). + EXTREME (6): + The given ranking expression is of Extreme + importance, and dominates job's final ranking + position with existing relevance score + (determined by API algorithm) ignored. """ IMPORTANCE_LEVEL_UNSPECIFIED = 0 NONE = 1 diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/tenant.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/tenant.py index acbf7d28cf2e..bbcf2dd88edc 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/tenant.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/types/tenant.py @@ -44,6 +44,7 @@ class Tenant(proto.Message): external_id (str): Required. Client side tenant identifier, used to uniquely identify the tenant. + The maximum number of allowed characters is 255. usage_type (google.cloud.talent_v4beta1.types.Tenant.DataUsageType): Indicates whether data owned by this tenant may be used to @@ -66,6 +67,17 @@ class Tenant(proto.Message): class DataUsageType(proto.Enum): r"""Enum that represents how user data owned by the tenant is used. + + Values: + DATA_USAGE_TYPE_UNSPECIFIED (0): + Default value. + AGGREGATED (1): + Data owned by this tenant is used to improve + search/recommendation quality across tenants. + ISOLATED (2): + Data owned by this tenant is used to improve + search/recommendation quality for this tenant + only. """ DATA_USAGE_TYPE_UNSPECIFIED = 0 AGGREGATED = 1 diff --git a/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4.json b/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4.json index 9c6c2b61abe3..055c070bd80b 100644 --- a/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4.json +++ b/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-talent", - "version": "2.9.0" + "version": "0.1.0" }, "snippets": [ { diff --git a/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4beta1.json b/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4beta1.json index e45027c835d8..4ece637720f6 100644 --- a/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4beta1.json +++ b/packages/google-cloud-talent/samples/generated_samples/snippet_metadata_google.cloud.talent.v4beta1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-talent", - "version": "2.9.0" + "version": "0.1.0" }, "snippets": [ {