diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/application_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/application_service_client.py index 58a388854c89..a3db300afdde 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/application_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/application_service_client.py @@ -237,17 +237,14 @@ def create_application( >>> response = client.create_application(parent, application) Args: - parent (str): Required. - - Resource name of the profile under which the application is created. + parent (str): Required. Resource name of the profile under which the application is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}", for example, "projects/test-project/tenants/test-tenant/profiles/test-profile". - application (Union[dict, ~google.cloud.talent_v4beta1.types.Application]): Required. - - The application to be created. + application (Union[dict, ~google.cloud.talent_v4beta1.types.Application]): Required. The application to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Application` @@ -321,9 +318,7 @@ def get_application( >>> response = client.get_application(name) Args: - name (str): Required. - - The resource name of the application to be retrieved. + name (str): Required. The resource name of the application to be retrieved. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}", @@ -399,9 +394,8 @@ def update_application( >>> response = client.update_application(application) Args: - application (Union[dict, ~google.cloud.talent_v4beta1.types.Application]): Required. - - The application resource to replace the current resource in the system. + application (Union[dict, ~google.cloud.talent_v4beta1.types.Application]): Required. The application resource to replace the current resource in the + system. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Application` @@ -485,9 +479,7 @@ def delete_application( >>> client.delete_application(name) Args: - name (str): Required. - - The resource name of the application to be deleted. + name (str): Required. The resource name of the application to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}", @@ -571,9 +563,8 @@ def list_applications( ... pass Args: - parent (str): Required. - - Resource name of the profile under which the application is created. + parent (str): Required. Resource name of the profile under which the application is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/company_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/company_service_client.py index 9caf57767a22..a63a50c8821a 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/company_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/company_service_client.py @@ -231,18 +231,15 @@ def create_company( >>> response = client.create_company(parent, company) Args: - parent (str): Required. - - Resource name of the tenant under which the company is created. + parent (str): Required. Resource name of the tenant under which the company is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". - company (Union[dict, ~google.cloud.talent_v4beta1.types.Company]): Required. - - The company to be created. + company (Union[dict, ~google.cloud.talent_v4beta1.types.Company]): Required. The company to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Company` @@ -316,9 +313,7 @@ def get_company( >>> response = client.get_company(name) Args: - name (str): Required. - - The resource name of the company to be retrieved. + name (str): Required. The resource name of the company to be retrieved. The format is "projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}", @@ -396,9 +391,8 @@ def update_company( >>> response = client.update_company(company) Args: - company (Union[dict, ~google.cloud.talent_v4beta1.types.Company]): Required. - - The company resource to replace the current resource in the system. + company (Union[dict, ~google.cloud.talent_v4beta1.types.Company]): Required. The company resource to replace the current resource in the + system. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Company` @@ -483,9 +477,7 @@ def delete_company( >>> client.delete_company(name) Args: - name (str): Required. - - The resource name of the company to be deleted. + name (str): Required. The resource name of the company to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}", @@ -572,9 +564,8 @@ def list_companies( ... pass Args: - parent (str): Required. - - Resource name of the tenant under which the company is created. + parent (str): Required. Resource name of the tenant under which the company is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". @@ -586,9 +577,7 @@ def list_companies( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - require_open_jobs (bool): Optional. - - Set to true if the companies requested must have open jobs. + require_open_jobs (bool): Optional. Set to true if the companies requested must have open jobs. Defaults to false. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/completion_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/completion_client.py index d0511a479a1f..650f30709b40 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/completion_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/completion_client.py @@ -240,30 +240,22 @@ def complete_query( >>> response = client.complete_query(parent, query, page_size) Args: - parent (str): Required. - - Resource name of tenant the completion is performed within. + parent (str): Required. Resource name of tenant the completion is performed within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - query (str): Required. - - The query used to generate suggestions. + query (str): Required. The query used to generate suggestions. The maximum number of allowed characters is 255. - page_size (int): Required. - - Completion result count. + page_size (int): Required. Completion result count. The maximum allowed page size is 10. - language_codes (list[str]): Optional. - - The list of languages of the query. This is the BCP-47 language code, - such as "en-US" or "sr-Latn". For more information, see `Tags for - Identifying Languages `__. + language_codes (list[str]): Optional. The list of languages of the query. This is the BCP-47 + language code, such as "en-US" or "sr-Latn". For more information, see + `Tags for Identifying Languages `__. For ``CompletionType.JOB_TITLE`` type, only open jobs with the same ``language_codes`` are returned. @@ -276,9 +268,7 @@ def complete_query( ``language_codes`` are returned. The maximum number of allowed characters is 255. - company (str): Optional. - - If provided, restricts completion to specified company. + company (str): Optional. If provided, restricts completion to specified company. The format is "projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}", @@ -286,12 +276,10 @@ def complete_query( Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". - scope (~google.cloud.talent_v4beta1.types.CompletionScope): Optional. - - The scope of the completion. The defaults is ``CompletionScope.PUBLIC``. - type_ (~google.cloud.talent_v4beta1.types.CompletionType): Optional. - - The completion topic. The default is ``CompletionType.COMBINED``. + scope (~google.cloud.talent_v4beta1.types.CompletionScope): Optional. The scope of the completion. The defaults is + ``CompletionScope.PUBLIC``. + type_ (~google.cloud.talent_v4beta1.types.CompletionType): Optional. The completion topic. The default is + ``CompletionType.COMBINED``. retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will not be retried. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/enums.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/enums.py index b29154a603f7..000d09aa38d7 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/enums.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/enums.py @@ -925,8 +925,82 @@ class ProfileEventType(enum.IntEnum): Attributes: PROFILE_EVENT_TYPE_UNSPECIFIED (int): Default value. - IMPRESSION (int): The profile is displayed. - VIEW (int): The profile is viewed. + IMPRESSION (int): Send this event when a ``ProfileEvent.profiles`` meets all of the + following criteria: + + - Was sent as a part of a result set for a CTS API call. + - Was rendered in the end user's UI (that is, the + ``ProfileEvent.recruiter``). + - That UI rendering was displayed in the end user's viewport for >=3 + seconds. + + In other words, send this event when the end user of the CTS service + actually saw a resulting profile in their viewport. + + To understand how to use this event, consider an example: + + - The customer's UI for interacting with CTS result sets is accessed by + the end user through a web browser. + - The UI calls for a page size of 15 candidates (that is, 15 candidates + are rendered on each page of results). + - However, the UI design calls for only 5 candidates to be shown at any + given time in the viewport (that is, the end user can only see 5 + results at any given time and needs to scroll up or down to view all + 15 results). + + To render each page of results, the customer will send a request to CTS + with a page size = 15. + + - User loads page #1 of results. + - User scrolls down to expose results #1 - #5 and dwells on this view + for 30 seconds. + - Send an IMPRESSION event for result 1, 2, 3, 4, 5. + - User scrolls down a bit, exposing results #2 - #6 in the viewport and + dwells on this view for 5 minutes. + - Send an IMPRESSION event for result 6. + - User scrolls to the bottom of the page, with results #7 - #15 shown + in the viewport for ~5 seconds each. + - Specifically, NO IMPRESSION events are sent for result 7, 8, 9, 10, + 11, 12, 13, 14, 15. + - User clicks to the next page and loads page #2 of results. + - Within 2 seconds, user scrolls to expose results #20 - #24 in the + viewport and dwells on this view for 20 mins. + - Send an IMPRESSION event for result 20, 21, 22, 23, 24 + - User closes their browser window. + VIEW (int): The VIEW event allows CTS to understand if a candidate's profile was + viewed by an end user (that is, recruiter) of the system for >=3 + seconds. This is critical to tracking product metrics and should be sent + for every profile VIEW that happens in the customer's system. + + VIEW events should be sent whether an end user views a candidate's + profile as a result of seeing that profile in the result set of a CTS + API request or whether the end user views the profile for some other + reason (that is, clicks to the candidate's profile in the ATS, and so + on). + + For a VIEW that happens as a result of seeing the profile in a CTS API + request's result set, the ``ClientEvent.request_id`` should be + populated. If the VIEW happens for some other reason, the [requestId] + should not be populated. + + This event requires a valid recruiter and one valid ID in profiles. + + To understand how to use this event, consider 2 examples in which a VIEW + event should be sent: + + - End user makes a request to the CTS API for a result set. + + - Results for the request are shown to the end user. + + - End user clicks on one of the candidates that are shown as part of + the results. + + - A VIEW event with the ``ClientEvent.request_id`` of the API call in + the first step of this example is sent. + + - End user browses to a candidate's profile in the ATS. + + - A VIEW event without a ``ClientEvent.request_id`` is sent. BOOKMARK (int): The profile is bookmarked. """ diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/event_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/event_service_client.py index 07c5fa8adabf..df397eba24e5 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/event_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/event_service_client.py @@ -230,19 +230,15 @@ def create_client_event( >>> response = client.create_client_event(parent, client_event) Args: - parent (str): Required. - - Resource name of the tenant under which the event is created. + parent (str): Required. Resource name of the tenant under which the event is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". - client_event (Union[dict, ~google.cloud.talent_v4beta1.types.ClientEvent]): Required. - - Events issued when end user interacts with customer's application that - uses Cloud Talent Solution. + client_event (Union[dict, ~google.cloud.talent_v4beta1.types.ClientEvent]): Required. Events issued when end user interacts with customer's application + that uses Cloud Talent Solution. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.ClientEvent` diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/job_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/job_service_client.py index 9d0f9449b7d9..3bccf7d8d7a6 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/job_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/job_service_client.py @@ -259,18 +259,15 @@ def create_job( >>> response = client.create_job(parent, job) Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the job is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". - job (Union[dict, ~google.cloud.talent_v4beta1.types.Job]): Required. - - The Job to be created. + job (Union[dict, ~google.cloud.talent_v4beta1.types.Job]): Required. The Job to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Job` @@ -343,9 +340,7 @@ def get_job( >>> response = client.get_job(name) Args: - name (str): Required. - - The resource name of the job to retrieve. + name (str): Required. The resource name of the job to retrieve. The format is "projects/{project\_id}/tenants/{tenant\_id}/jobs/{job\_id}", for @@ -426,9 +421,7 @@ def update_job( >>> response = client.update_job(job) Args: - job (Union[dict, ~google.cloud.talent_v4beta1.types.Job]): Required. - - The Job to be updated. + job (Union[dict, ~google.cloud.talent_v4beta1.types.Job]): Required. The Job to be updated. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Job` @@ -514,9 +507,7 @@ def delete_job( >>> client.delete_job(name) Args: - name (str): Required. - - The resource name of the job to be deleted. + name (str): Required. The resource name of the job to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/jobs/{job\_id}", for @@ -607,18 +598,15 @@ def list_jobs( ... pass Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the job is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - filter_ (str): Required. - - The filter string specifies the jobs to be enumerated. + filter_ (str): Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND @@ -641,10 +629,9 @@ def list_jobs( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. - - The desired job attributes returned for jobs in the search response. - Defaults to ``JobView.JOB_VIEW_FULL`` if no value is specified. + job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. The desired job attributes returned for jobs in the search + response. Defaults to ``JobView.JOB_VIEW_FULL`` if no value is + specified. retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will not be retried. @@ -733,18 +720,15 @@ def batch_delete_jobs( >>> client.batch_delete_jobs(parent, filter_) Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the job is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - filter_ (str): Required. - - The filter string specifies the jobs to be deleted. + filter_ (str): Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND @@ -851,45 +835,34 @@ def search_jobs( ... pass Args: - parent (str): Required. - - The resource name of the tenant to search within. + parent (str): Required. The resource name of the tenant to search within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. - - The meta information collected about the job searcher, used to improve - the search quality of the service.. The identifiers, (such as + request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. The meta information collected about the job searcher, used to + improve the search quality of the service. The identifiers (such as ``user_id``) are provided by users, and must be unique and consistent. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.RequestMetadata` - search_mode (~google.cloud.talent_v4beta1.types.SearchMode): Optional. - - Mode of a search. + search_mode (~google.cloud.talent_v4beta1.types.SearchMode): Optional. Mode of a search. Defaults to ``SearchMode.JOB_SEARCH``. - job_query (Union[dict, ~google.cloud.talent_v4beta1.types.JobQuery]): Optional. - - Query used to search against jobs, such as keyword, location filters, etc. + job_query (Union[dict, ~google.cloud.talent_v4beta1.types.JobQuery]): Optional. Query used to search against jobs, such as keyword, location + filters, etc. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.JobQuery` - enable_broadening (bool): Optional. - - Controls whether to broaden the search when it produces sparse results. - Broadened queries append results to the end of the matching results - list. + enable_broadening (bool): Optional. Controls whether to broaden the search when it produces sparse + results. Broadened queries append results to the end of the matching + results list. Defaults to false. - require_precise_result_size (bool): Optional. - - Controls if the search job request requires the return of a precise - count of the first 300 results. Setting this to ``true`` ensures + require_precise_result_size (bool): Optional. Controls if the search job request requires the return of a + precise count of the first 300 results. Setting this to ``true`` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. @@ -897,9 +870,8 @@ def search_jobs( Enabling this flag may adversely impact performance. Defaults to false. - histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. - - An expression specifies a histogram request against matching jobs. + histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. An expression specifies a histogram request against matching + jobs. Expression syntax is an aggregation function call with histogram facets and other options. @@ -993,15 +965,13 @@ def search_jobs( If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.HistogramQuery` - job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. - - The desired job attributes returned for jobs in the search response. - Defaults to ``JobView.JOB_VIEW_SMALL`` if no value is specified. - offset (int): Optional. - - An integer that specifies the current offset (that is, starting result - location, amongst the jobs deemed by the API as relevant) in search - results. This field is only considered if ``page_token`` is unset. + job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. The desired job attributes returned for jobs in the search + response. Defaults to ``JobView.JOB_VIEW_SMALL`` if no value is + specified. + offset (int): Optional. An integer that specifies the current offset (that is, + starting result location, amongst the jobs deemed by the API as + relevant) in search results. This field is only considered if + ``page_token`` is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for @@ -1012,81 +982,78 @@ def search_jobs( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - order_by (str): Optional. - - The criteria determining how search results are sorted. Default is - "relevance desc". + order_by (str): Optional. The criteria determining how search results are sorted. + Default is ``"relevance desc"``. Supported options are: - - "relevance desc": By relevance descending, as determined by the API - algorithms. Relevance thresholding of query results is only available - with this ordering. - - "posting``_``\ publish\ ``_``\ time desc": By - ``Job.posting_publish_time`` descending. - - "posting``_``\ update\ ``_``\ time desc": By - ``Job.posting_update_time`` descending. - - "title": By ``Job.title`` ascending. - - "title desc": By ``Job.title`` descending. - - "annualized``_``\ base\ ``_``\ compensation": By job's + - ``"relevance desc"``: By relevance descending, as determined by the + API algorithms. Relevance thresholding of query results is only + available with this ordering. + - ``"posting_publish_time desc"``: By ``Job.posting_publish_time`` + descending. + - ``"posting_update_time desc"``: By ``Job.posting_update_time`` + descending. + - ``"title"``: By ``Job.title`` ascending. + - ``"title desc"``: By ``Job.title`` descending. + - ``"annualized_base_compensation"``: By job's ``CompensationInfo.annualized_base_compensation_range`` ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ base\ ``_``\ compensation desc": By job's + - ``"annualized_base_compensation desc"``: By job's ``CompensationInfo.annualized_base_compensation_range`` descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ total\ ``_``\ compensation": By job's + - ``"annualized_total_compensation"``: By job's ``CompensationInfo.annualized_total_compensation_range`` ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ total\ ``_``\ compensation desc": By job's + - ``"annualized_total_compensation desc"``: By job's ``CompensationInfo.annualized_total_compensation_range`` descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "custom``_``\ ranking desc": By the relevance score adjusted to the + - ``"custom_ranking desc"``: By the relevance score adjusted to the ``SearchJobsRequest.CustomRankingInfo.ranking_expression`` with weight factor assigned by ``SearchJobsRequest.CustomRankingInfo.importance_level`` in descending order. - - "location``_``\ distance": By the distance between the location on - jobs and locations specified in the ``JobQuery.location_filters``. - When this order is selected, the ``JobQuery.location_filters`` must - not be empty. When a job has multiple locations, the location closest - to one of the locations specified in the location filter will be used - to calculate location distance. Distance is calculated by the - distance between two lat/long coordinates, with a precision of 10e-4 - degrees (11.3 meters). Jobs that don't have locations specified will - be ranked below jobs having locations. Diversification strategy is - still applied unless explicitly disabled in - ``SearchJobsRequest.diversification_level``. - diversification_level (~google.cloud.talent_v4beta1.types.DiversificationLevel): Optional. - - Controls whether highly similar jobs are returned next to each other in - the search results. Jobs are identified as highly similar based on their - titles, job categories, and locations. Highly similar results are - clustered so that only one representative job of the cluster is + - Location sorting: Use the special syntax to order jobs by distance: + ``"distance_from('Hawaii')"``: Order by distance from Hawaii. + ``"distance_from(19.89, 155.5)"``: Order by distance from a + coordinate. + ``"distance_from('Hawaii'), distance_from('Puerto Rico')"``: Order by + multiple locations. See details below. + ``"distance_from('Hawaii'), distance_from(19.89, 155.5)"``: Order by + multiple locations. See details below. The string can have a maximum + of 256 characters. When multiple distance centers are provided, a job + that is close to any of the distance centers would have a high rank. + When a job has multiple locations, the job location closest to one of + the distance centers will be used. Jobs that don't have locations + will be ranked at the bottom. Distance is calculated with a precision + of 11.3 meters (37.4 feet). Diversification strategy is still applied + unless explicitly disabled in ``diversification_level``. + diversification_level (~google.cloud.talent_v4beta1.types.DiversificationLevel): Optional. Controls whether highly similar jobs are returned next to each + other in the search results. Jobs are identified as highly similar based + on their titles, job categories, and locations. Highly similar results + are clustered so that only one 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. Defaults to ``DiversificationLevel.SIMPLE`` if no value is specified. - custom_ranking_info (Union[dict, ~google.cloud.talent_v4beta1.types.CustomRankingInfo]): Optional. - - Controls over how job documents get ranked on top of existing relevance - score (determined by API algorithm). + custom_ranking_info (Union[dict, ~google.cloud.talent_v4beta1.types.CustomRankingInfo]): Optional. Controls over how job documents get ranked on top of existing + relevance score (determined by API algorithm). If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.CustomRankingInfo` - disable_keyword_match (bool): Optional. - - Controls whether to disable exact keyword match on ``Job.title``, - ``Job.description``, ``Job.company_display_name``, ``Job.addresses``, - ``Job.qualifications``. When disable keyword match is turned off, a - keyword match returns jobs that do not match given category filters when - there are matching keywords. For example, for the query "program - manager," a result is returned even if the job posting has the title - "software developer," which doesn't fall into "program manager" - ontology, but does have "program manager" appearing in its description. + disable_keyword_match (bool): Optional. Controls whether to disable exact keyword match on + ``Job.title``, ``Job.description``, ``Job.company_display_name``, + ``Job.addresses``, ``Job.qualifications``. When disable keyword match is + turned off, a keyword match returns jobs that do not match given + category filters when there are matching keywords. For example, for the + query "program manager," a result is returned even if the job posting + has the title "software developer," which doesn't fall into "program + manager" ontology, but does have "program manager" appearing in its + description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of @@ -1231,45 +1198,34 @@ def search_jobs_for_alert( ... pass Args: - parent (str): Required. - - The resource name of the tenant to search within. + parent (str): Required. The resource name of the tenant to search within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. - - The meta information collected about the job searcher, used to improve - the search quality of the service.. The identifiers, (such as + request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. The meta information collected about the job searcher, used to + improve the search quality of the service. The identifiers (such as ``user_id``) are provided by users, and must be unique and consistent. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.RequestMetadata` - search_mode (~google.cloud.talent_v4beta1.types.SearchMode): Optional. - - Mode of a search. + search_mode (~google.cloud.talent_v4beta1.types.SearchMode): Optional. Mode of a search. Defaults to ``SearchMode.JOB_SEARCH``. - job_query (Union[dict, ~google.cloud.talent_v4beta1.types.JobQuery]): Optional. - - Query used to search against jobs, such as keyword, location filters, etc. + job_query (Union[dict, ~google.cloud.talent_v4beta1.types.JobQuery]): Optional. Query used to search against jobs, such as keyword, location + filters, etc. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.JobQuery` - enable_broadening (bool): Optional. - - Controls whether to broaden the search when it produces sparse results. - Broadened queries append results to the end of the matching results - list. + enable_broadening (bool): Optional. Controls whether to broaden the search when it produces sparse + results. Broadened queries append results to the end of the matching + results list. Defaults to false. - require_precise_result_size (bool): Optional. - - Controls if the search job request requires the return of a precise - count of the first 300 results. Setting this to ``true`` ensures + require_precise_result_size (bool): Optional. Controls if the search job request requires the return of a + precise count of the first 300 results. Setting this to ``true`` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. @@ -1277,9 +1233,8 @@ def search_jobs_for_alert( Enabling this flag may adversely impact performance. Defaults to false. - histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. - - An expression specifies a histogram request against matching jobs. + histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. An expression specifies a histogram request against matching + jobs. Expression syntax is an aggregation function call with histogram facets and other options. @@ -1373,15 +1328,13 @@ def search_jobs_for_alert( If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.HistogramQuery` - job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. - - The desired job attributes returned for jobs in the search response. - Defaults to ``JobView.JOB_VIEW_SMALL`` if no value is specified. - offset (int): Optional. - - An integer that specifies the current offset (that is, starting result - location, amongst the jobs deemed by the API as relevant) in search - results. This field is only considered if ``page_token`` is unset. + job_view (~google.cloud.talent_v4beta1.types.JobView): Optional. The desired job attributes returned for jobs in the search + response. Defaults to ``JobView.JOB_VIEW_SMALL`` if no value is + specified. + offset (int): Optional. An integer that specifies the current offset (that is, + starting result location, amongst the jobs deemed by the API as + relevant) in search results. This field is only considered if + ``page_token`` is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for @@ -1392,81 +1345,78 @@ def search_jobs_for_alert( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - order_by (str): Optional. - - The criteria determining how search results are sorted. Default is - "relevance desc". + order_by (str): Optional. The criteria determining how search results are sorted. + Default is ``"relevance desc"``. Supported options are: - - "relevance desc": By relevance descending, as determined by the API - algorithms. Relevance thresholding of query results is only available - with this ordering. - - "posting``_``\ publish\ ``_``\ time desc": By - ``Job.posting_publish_time`` descending. - - "posting``_``\ update\ ``_``\ time desc": By - ``Job.posting_update_time`` descending. - - "title": By ``Job.title`` ascending. - - "title desc": By ``Job.title`` descending. - - "annualized``_``\ base\ ``_``\ compensation": By job's + - ``"relevance desc"``: By relevance descending, as determined by the + API algorithms. Relevance thresholding of query results is only + available with this ordering. + - ``"posting_publish_time desc"``: By ``Job.posting_publish_time`` + descending. + - ``"posting_update_time desc"``: By ``Job.posting_update_time`` + descending. + - ``"title"``: By ``Job.title`` ascending. + - ``"title desc"``: By ``Job.title`` descending. + - ``"annualized_base_compensation"``: By job's ``CompensationInfo.annualized_base_compensation_range`` ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ base\ ``_``\ compensation desc": By job's + - ``"annualized_base_compensation desc"``: By job's ``CompensationInfo.annualized_base_compensation_range`` descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ total\ ``_``\ compensation": By job's + - ``"annualized_total_compensation"``: By job's ``CompensationInfo.annualized_total_compensation_range`` ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "annualized``_``\ total\ ``_``\ compensation desc": By job's + - ``"annualized_total_compensation desc"``: By job's ``CompensationInfo.annualized_total_compensation_range`` descending. Jobs whose annualized base compensation is unspecified are put at the end of search results. - - "custom``_``\ ranking desc": By the relevance score adjusted to the + - ``"custom_ranking desc"``: By the relevance score adjusted to the ``SearchJobsRequest.CustomRankingInfo.ranking_expression`` with weight factor assigned by ``SearchJobsRequest.CustomRankingInfo.importance_level`` in descending order. - - "location``_``\ distance": By the distance between the location on - jobs and locations specified in the ``JobQuery.location_filters``. - When this order is selected, the ``JobQuery.location_filters`` must - not be empty. When a job has multiple locations, the location closest - to one of the locations specified in the location filter will be used - to calculate location distance. Distance is calculated by the - distance between two lat/long coordinates, with a precision of 10e-4 - degrees (11.3 meters). Jobs that don't have locations specified will - be ranked below jobs having locations. Diversification strategy is - still applied unless explicitly disabled in - ``SearchJobsRequest.diversification_level``. - diversification_level (~google.cloud.talent_v4beta1.types.DiversificationLevel): Optional. - - Controls whether highly similar jobs are returned next to each other in - the search results. Jobs are identified as highly similar based on their - titles, job categories, and locations. Highly similar results are - clustered so that only one representative job of the cluster is + - Location sorting: Use the special syntax to order jobs by distance: + ``"distance_from('Hawaii')"``: Order by distance from Hawaii. + ``"distance_from(19.89, 155.5)"``: Order by distance from a + coordinate. + ``"distance_from('Hawaii'), distance_from('Puerto Rico')"``: Order by + multiple locations. See details below. + ``"distance_from('Hawaii'), distance_from(19.89, 155.5)"``: Order by + multiple locations. See details below. The string can have a maximum + of 256 characters. When multiple distance centers are provided, a job + that is close to any of the distance centers would have a high rank. + When a job has multiple locations, the job location closest to one of + the distance centers will be used. Jobs that don't have locations + will be ranked at the bottom. Distance is calculated with a precision + of 11.3 meters (37.4 feet). Diversification strategy is still applied + unless explicitly disabled in ``diversification_level``. + diversification_level (~google.cloud.talent_v4beta1.types.DiversificationLevel): Optional. Controls whether highly similar jobs are returned next to each + other in the search results. Jobs are identified as highly similar based + on their titles, job categories, and locations. Highly similar results + are clustered so that only one 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. Defaults to ``DiversificationLevel.SIMPLE`` if no value is specified. - custom_ranking_info (Union[dict, ~google.cloud.talent_v4beta1.types.CustomRankingInfo]): Optional. - - Controls over how job documents get ranked on top of existing relevance - score (determined by API algorithm). + custom_ranking_info (Union[dict, ~google.cloud.talent_v4beta1.types.CustomRankingInfo]): Optional. Controls over how job documents get ranked on top of existing + relevance score (determined by API algorithm). If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.CustomRankingInfo` - disable_keyword_match (bool): Optional. - - Controls whether to disable exact keyword match on ``Job.title``, - ``Job.description``, ``Job.company_display_name``, ``Job.addresses``, - ``Job.qualifications``. When disable keyword match is turned off, a - keyword match returns jobs that do not match given category filters when - there are matching keywords. For example, for the query "program - manager," a result is returned even if the job posting has the title - "software developer," which doesn't fall into "program manager" - ontology, but does have "program manager" appearing in its description. + disable_keyword_match (bool): Optional. Controls whether to disable exact keyword match on + ``Job.title``, ``Job.description``, ``Job.company_display_name``, + ``Job.addresses``, ``Job.qualifications``. When disable keyword match is + turned off, a keyword match returns jobs that do not match given + category filters when there are matching keywords. For example, for the + query "program manager," a result is returned even if the job posting + has the title "software developer," which doesn't fall into "program + manager" ontology, but does have "program manager" appearing in its + description. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of @@ -1588,18 +1538,15 @@ def batch_create_jobs( >>> metadata = response.metadata() Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the job is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". - jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): Required. - - The jobs to be created. + jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): Required. The jobs to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Job` @@ -1691,18 +1638,15 @@ def batch_update_jobs( >>> metadata = response.metadata() Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the job is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". - jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): Required. - - The jobs to be updated. + jobs (list[Union[dict, ~google.cloud.talent_v4beta1.types.Job]]): Required. The jobs to be updated. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Job` diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/profile_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/profile_service_client.py index d13cb29a509e..2f91b8e19f56 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/profile_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/profile_service_client.py @@ -260,9 +260,8 @@ def list_profiles( ... pass Args: - parent (str): Required. - - The resource name of the tenant under which the job is created. + parent (str): Required. The resource name of the tenant under which the profile is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". @@ -271,10 +270,8 @@ def list_profiles( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - read_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional. - - A field mask to specify the profile fields to be listed in response. All - fields are listed if it is unset. + read_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional. A field mask to specify the profile fields to be listed in + response. All fields are listed if it is unset. Valid values are: @@ -370,15 +367,11 @@ def create_profile( >>> response = client.create_profile(parent, profile) Args: - parent (str): Required. - - The name of the tenant this profile belongs to. + parent (str): Required. The name of the tenant this profile belongs to. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". - profile (Union[dict, ~google.cloud.talent_v4beta1.types.Profile]): Required. - - The profile to be created. + profile (Union[dict, ~google.cloud.talent_v4beta1.types.Profile]): Required. The profile to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Profile` @@ -452,9 +445,7 @@ def get_profile( >>> response = client.get_profile(name) Args: - name (str): Required. - - Resource name of the profile to get. + name (str): Required. Resource name of the profile to get. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}", @@ -529,43 +520,39 @@ def update_profile( >>> response = client.update_profile(profile) Args: - profile (Union[dict, ~google.cloud.talent_v4beta1.types.Profile]): Required. - - Profile to be updated. + profile (Union[dict, ~google.cloud.talent_v4beta1.types.Profile]): Required. Profile to be updated. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Profile` - update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional. - - A field mask to specify the profile fields to update. + update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional. A field mask to specify the profile fields to update. A full update is performed if it is unset. Valid values are: - - externalId + - external\_id - source - uri - - isHirable - - createTime - - updateTime - - resumeHrxml - - personNames + - is\_hirable + - create\_time + - update\_time + - resume + - person\_names - addresses - - emailAddresses - - phoneNumbers - - personalUris - - additionalContactInfo - - employmentRecords - - educationRecords + - email\_addresses + - phone\_numbers + - personal\_uris + - additional\_contact\_info + - employment\_records + - education\_records - skills - projects - publications - patents - certifications - - recruitingNotes - - customAttributes - - groupId + - recruiting\_notes + - custom\_attributes + - group\_id If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.FieldMask` @@ -641,9 +628,7 @@ def delete_profile( >>> client.delete_profile(name) Args: - name (str): Required. - - Resource name of the profile to be deleted. + name (str): Required. Resource name of the profile to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}", @@ -704,6 +689,7 @@ def search_profiles( order_by=None, case_sensitive_sort=None, histogram_queries=None, + result_set_id=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, @@ -742,23 +728,18 @@ def search_profiles( ... pass Args: - parent (str): Required. - - The resource name of the tenant to search within. + parent (str): Required. The resource name of the tenant to search within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". - request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. - - The meta information collected about the profile search user. This is used - to improve the search quality of the service. These values are provided by - users, and must be precise and consistent. + request_metadata (Union[dict, ~google.cloud.talent_v4beta1.types.RequestMetadata]): Required. The meta information collected about the profile search user. + This is used to improve the search quality of the service. These values are + provided by users, and must be precise and consistent. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.RequestMetadata` - profile_query (Union[dict, ~google.cloud.talent_v4beta1.types.ProfileQuery]): Optional. - - Search query to execute. See ``ProfileQuery`` for more details. + profile_query (Union[dict, ~google.cloud.talent_v4beta1.types.ProfileQuery]): Optional. Search query to execute. See ``ProfileQuery`` for more + details. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.ProfileQuery` @@ -767,11 +748,9 @@ def search_profiles( resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. - offset (int): Optional. - - An integer that specifies the current offset (that is, starting result) - in search results. This field is only considered if ``page_token`` is - unset. + offset (int): Optional. An integer that specifies the current offset (that is, + starting result) in search results. This field is only considered if + ``page_token`` is unset. The maximum allowed value is 5000. Otherwise an error is thrown. @@ -779,16 +758,12 @@ def search_profiles( search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page. - disable_spell_check (bool): Optional. - - This flag controls the spell-check feature. If ``false``, the service - attempts to correct a misspelled query. + disable_spell_check (bool): Optional. This flag controls the spell-check feature. If ``false``, the + service attempts to correct a misspelled query. For example, "enginee" is corrected to "engineer". - order_by (str): Optional. - - The criteria that determines how search results are sorted. Defaults is - "relevance desc" if no value is specified. + order_by (str): Optional. The criteria that determines how search results are sorted. + Defaults is "relevance desc" if no value is specified. Supported options are: @@ -806,15 +781,11 @@ def search_profiles( in ascending order. - "last\_name desc": Sort by ``PersonName.PersonStructuredName.family_name`` in ascending order. - case_sensitive_sort (bool): Optional. - - When sort by field is based on alphabetical order, sort values case - sensitively (based on ASCII) when the value is set to true. Default value - is case in-sensitive sort (false). - histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. - - A list of expressions specifies histogram requests against matching - profiles for ``SearchProfilesRequest``. + case_sensitive_sort (bool): Optional. When sort by field is based on alphabetical order, sort values + case sensitively (based on ASCII) when the value is set to true. Default + value is case in-sensitive sort (false). + histogram_queries (list[Union[dict, ~google.cloud.talent_v4beta1.types.HistogramQuery]]): Optional. A list of expressions specifies histogram requests against + matching profiles for ``SearchProfilesRequest``. The expression syntax looks like a function definition with optional parameters. @@ -893,6 +864,25 @@ def search_profiles( If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.HistogramQuery` + result_set_id (str): Optional. An id that uniquely identifies the result set of a + ``SearchProfiles`` call. The id should be retrieved from the + ``SearchProfilesResponse`` message returned from a previous invocation + of ``SearchProfiles``. + + A result set is an ordered list of search results. + + If this field is not set, a new result set is computed based on the + ``profile_query``. A new ``result_set_id`` is returned as a handle to + access this result set. + + If this field is set, the service will ignore the resource and + ``profile_query`` values, and simply retrieve a page of results from the + corresponding result set. In this case, one and only one of + [page\_token] or [offset] must be set. + + A typical use case is to invoke ``SearchProfilesRequest`` without this + field, then use the resulting ``result_set_id`` in + ``SearchProfilesResponse`` to page through the results. retry (Optional[google.api_core.retry.Retry]): A retry object used to retry requests. If ``None`` is specified, requests will not be retried. @@ -936,6 +926,7 @@ def search_profiles( order_by=order_by, case_sensitive_sort=case_sensitive_sort, histogram_queries=histogram_queries, + result_set_id=result_set_id, ) if metadata is None: metadata = [] diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/tenant_service_client.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/tenant_service_client.py index f6b6148d23ce..d3e8bb4263c0 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/tenant_service_client.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/gapic/tenant_service_client.py @@ -247,15 +247,12 @@ def create_tenant( >>> response = client.create_tenant(parent, tenant) Args: - parent (str): Required. - - Resource name of the project under which the tenant is created. + parent (str): Required. Resource name of the project under which the tenant is + created. The format is "projects/{project\_id}", for example, "projects/api-test-project". - tenant (Union[dict, ~google.cloud.talent_v4beta1.types.Tenant]): Required. - - The tenant to be created. + tenant (Union[dict, ~google.cloud.talent_v4beta1.types.Tenant]): Required. The tenant to be created. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Tenant` @@ -327,9 +324,7 @@ def get_tenant( >>> response = client.get_tenant(name) Args: - name (str): Required. - - The resource name of the tenant to be retrieved. + name (str): Required. The resource name of the tenant to be retrieved. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". @@ -403,9 +398,8 @@ def update_tenant( >>> response = client.update_tenant(tenant) Args: - tenant (Union[dict, ~google.cloud.talent_v4beta1.types.Tenant]): Required. - - The tenant resource to replace the current resource in the system. + tenant (Union[dict, ~google.cloud.talent_v4beta1.types.Tenant]): Required. The tenant resource to replace the current resource in the + system. If a dict is provided, it must be of the same form as the protobuf message :class:`~google.cloud.talent_v4beta1.types.Tenant` @@ -489,9 +483,7 @@ def delete_tenant( >>> client.delete_tenant(name) Args: - name (str): Required. - - The resource name of the tenant to be deleted. + name (str): Required. The resource name of the tenant to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". @@ -573,9 +565,8 @@ def list_tenants( ... pass Args: - parent (str): Required. - - Resource name of the project under which the tenant is created. + parent (str): Required. Resource name of the project under which the tenant is + created. The format is "projects/{project\_id}", for example, "projects/api-test-project". diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application.proto index c09efae00d6f..30ce2fed8d1e 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application.proto @@ -97,9 +97,7 @@ message Application { // "projects/api-test-project/tenants/foo/profiles/bar/applications/baz". string name = 1; - // Required. - // - // Client side application identifier, used to uniquely identify the + // Required. Client side application identifier, used to uniquely identify the // application. // // The maximum number of allowed characters is 255. @@ -130,57 +128,40 @@ message Application { // for example, "projects/api-test-project/tenants/foo/companies/bar". string company = 5; - // Optional. - // - // The application date. + // Optional. The application date. google.type.Date application_date = 7; - // Required. - // - // What is the most recent stage of the application (that is, new, screen, - // send cv, hired, finished work)? This field is intentionally not + // Required. What is the most recent stage of the application (that is, new, + // screen, send cv, hired, finished work)? This field is intentionally not // comprehensive of every possible status, but instead, represents statuses // that would be used to indicate to the ML models good / bad matches. ApplicationStage stage = 11; - // Optional. - // - // The application state. + // Optional. The application state. ApplicationState state = 13; - // Optional. - // - // All interviews (screen, onsite, and so on) conducted as part of this - // application (includes details such as user conducting the interview, + // Optional. All interviews (screen, onsite, and so on) conducted as part of + // this application (includes details such as user conducting the interview, // timestamp, feedback, and so on). repeated Interview interviews = 16; - // Optional. - // - // If the candidate is referred by a employee. + // Optional. If the candidate is referred by a employee. google.protobuf.BoolValue referral = 18; - // Required. - // - // Reflects the time that the application was created. + // Required. Reflects the time that the application was created. google.protobuf.Timestamp create_time = 19; - // Optional. - // - // The last update timestamp. + // Optional. The last update timestamp. google.protobuf.Timestamp update_time = 20; - // Optional. - // - // Free text reason behind the recruitement outcome (for example, reason for - // withdraw / reject, reason for an unsuccessful finish, and so on). + // Optional. Free text reason behind the recruitement outcome (for example, + // reason for withdraw / reject, reason for an unsuccessful finish, and so + // on). // // Number of characters allowed is 100. string outcome_notes = 21; - // Optional. - // - // Outcome positiveness shows how positive the outcome is. + // Optional. Outcome positiveness shows how positive the outcome is. Outcome outcome = 22; // Output only. Indicates whether this job application is a match to diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_pb2.py index b7e22012b438..f41b59fe646b 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_pb2.py @@ -490,9 +490,9 @@ application\_id}", for example, "projects/api-test- project/tenants/foo/profiles/bar/applications/baz". external_id: - Required. Client side application identifier, used to - uniquely identify the application. The maximum number of - allowed characters is 255. + Required. Client side application identifier, used to uniquely + identify the application. The maximum number of allowed + characters is 255. profile: Output only. Resource name of the candidate of this application. The format is "projects/{project\_id}/tenants/{t @@ -510,33 +510,32 @@ y\_id}", for example, "projects/api-test- project/tenants/foo/companies/bar". application_date: - Optional. The application date. + Optional. The application date. stage: - Required. What is the most recent stage of the application + Required. What is the most recent stage of the application (that is, new, screen, send cv, hired, finished work)? This field is intentionally not comprehensive of every possible status, but instead, represents statuses that would be used to indicate to the ML models good / bad matches. state: - Optional. The application state. + Optional. The application state. interviews: - Optional. All interviews (screen, onsite, and so on) - conducted as part of this application (includes details such - as user conducting the interview, timestamp, feedback, and so - on). + Optional. All interviews (screen, onsite, and so on) conducted + as part of this application (includes details such as user + conducting the interview, timestamp, feedback, and so on). referral: - Optional. If the candidate is referred by a employee. + Optional. If the candidate is referred by a employee. create_time: - Required. Reflects the time that the application was created. + Required. Reflects the time that the application was created. update_time: - Optional. The last update timestamp. + Optional. The last update timestamp. outcome_notes: - Optional. Free text reason behind the recruitement outcome + Optional. Free text reason behind the recruitement outcome (for example, reason for withdraw / reject, reason for an unsuccessful finish, and so on). Number of characters allowed is 100. outcome: - Optional. Outcome positiveness shows how positive the outcome + Optional. Outcome positiveness shows how positive the outcome is. is_match: Output only. Indicates whether this job application is a match diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service.proto index 4ff4a026f352..48e4f9500d22 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/application.proto"; import "google/cloud/talent/v4beta1/common.proto"; import "google/protobuf/empty.proto"; @@ -32,6 +33,11 @@ option objc_class_prefix = "CTS"; // A service that handles application management, including CRUD and // enumeration. service ApplicationService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Creates a new application entity. rpc CreateApplication(CreateApplicationRequest) returns (Application) { option (google.api.http) = { @@ -56,14 +62,16 @@ service ApplicationService { } // Deletes specified application. - rpc DeleteApplication(DeleteApplicationRequest) returns (google.protobuf.Empty) { + rpc DeleteApplication(DeleteApplicationRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}" }; } // Lists all applications associated with the profile. - rpc ListApplications(ListApplicationsRequest) returns (ListApplicationsResponse) { + rpc ListApplications(ListApplicationsRequest) + returns (ListApplicationsResponse) { option (google.api.http) = { get: "/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications" }; @@ -72,26 +80,21 @@ service ApplicationService { // The Request of the CreateApplication method. message CreateApplicationRequest { - // Required. - // - // Resource name of the profile under which the application is created. + // Required. Resource name of the profile under which the application is + // created. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for // example, "projects/test-project/tenants/test-tenant/profiles/test-profile". string parent = 1; - // Required. - // - // The application to be created. + // Required. The application to be created. Application application = 2; } // Request for getting a application by name. message GetApplicationRequest { - // Required. - // - // The resource name of the application to be retrieved. + // Required. The resource name of the application to be retrieved. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}", @@ -102,27 +105,28 @@ message GetApplicationRequest { // Request for updating a specified application. message UpdateApplicationRequest { - // Required. - // - // The application resource to replace the current resource in the system. + // Required. The application resource to replace the current resource in the + // system. Application application = 1; // Optional but strongly recommended for the best service // experience. // - // If [update_mask][google.cloud.talent.v4beta1.UpdateApplicationRequest.update_mask] is provided, only the specified fields in - // [application][google.cloud.talent.v4beta1.UpdateApplicationRequest.application] are updated. Otherwise all the fields are updated. + // If + // [update_mask][google.cloud.talent.v4beta1.UpdateApplicationRequest.update_mask] + // is provided, only the specified fields in + // [application][google.cloud.talent.v4beta1.UpdateApplicationRequest.application] + // are updated. Otherwise all the fields are updated. // // A field mask to specify the application fields to be updated. Only - // top level fields of [Application][google.cloud.talent.v4beta1.Application] are supported. + // top level fields of [Application][google.cloud.talent.v4beta1.Application] + // are supported. google.protobuf.FieldMask update_mask = 2; } // Request to delete a application. message DeleteApplicationRequest { - // Required. - // - // The resource name of the application to be deleted. + // Required. The resource name of the application to be deleted. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}", @@ -133,23 +137,18 @@ message DeleteApplicationRequest { // List applications for which the client has ACL visibility. message ListApplicationsRequest { - // Required. - // - // Resource name of the profile under which the application is created. + // Required. Resource name of the profile under which the application is + // created. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for // example, "projects/test-project/tenants/test-tenant/profiles/test-profile". string parent = 1; - // Optional. - // - // The starting indicator from which to return results. + // Optional. The starting indicator from which to return results. string page_token = 2; - // Optional. - // - // The maximum number of applications to be returned, at most 100. + // Optional. The maximum number of applications to be returned, at most 100. // Default is 100 if a non-positive number is provided. int32 page_size = 3; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service_pb2.py index 530dc855c1df..f1e3e31fbbc6 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/application_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( application_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_application__pb2, ) @@ -34,10 +35,11 @@ "\n\037com.google.cloud.talent.v4beta1B\027ApplicationServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n;google/cloud/talent_v4beta1/proto/application_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x33google/cloud/talent_v4beta1/proto/application.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"i\n\x18\x43reateApplicationRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12=\n\x0b\x61pplication\x18\x02 \x01(\x0b\x32(.google.cloud.talent.v4beta1.Application"%\n\x15GetApplicationRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"\x8a\x01\n\x18UpdateApplicationRequest\x12=\n\x0b\x61pplication\x18\x01 \x01(\x0b\x32(.google.cloud.talent.v4beta1.Application\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"(\n\x18\x44\x65leteApplicationRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"P\n\x17ListApplicationsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05"\xb4\x01\n\x18ListApplicationsResponse\x12>\n\x0c\x61pplications\x18\x01 \x03(\x0b\x32(.google.cloud.talent.v4beta1.Application\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\xd4\x07\n\x12\x41pplicationService\x12\xbf\x01\n\x11\x43reateApplication\x12\x35.google.cloud.talent.v4beta1.CreateApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"I\x82\xd3\xe4\x93\x02\x43">/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications:\x01*\x12\xb6\x01\n\x0eGetApplication\x12\x32.google.cloud.talent.v4beta1.GetApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"F\x82\xd3\xe4\x93\x02@\x12>/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}\x12\xcb\x01\n\x11UpdateApplication\x12\x35.google.cloud.talent.v4beta1.UpdateApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"U\x82\xd3\xe4\x93\x02O2J/v4beta1/{application.name=projects/*/tenants/*/profiles/*/applications/*}:\x01*\x12\xaa\x01\n\x11\x44\x65leteApplication\x12\x35.google.cloud.talent.v4beta1.DeleteApplicationRequest\x1a\x16.google.protobuf.Empty"F\x82\xd3\xe4\x93\x02@*>/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}\x12\xc7\x01\n\x10ListApplications\x12\x34.google.cloud.talent.v4beta1.ListApplicationsRequest\x1a\x35.google.cloud.talent.v4beta1.ListApplicationsResponse"F\x82\xd3\xe4\x93\x02@\x12>/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applicationsB\x85\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x17\x41pplicationServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n;google/cloud/talent_v4beta1/proto/application_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x33google/cloud/talent_v4beta1/proto/application.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"i\n\x18\x43reateApplicationRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12=\n\x0b\x61pplication\x18\x02 \x01(\x0b\x32(.google.cloud.talent.v4beta1.Application"%\n\x15GetApplicationRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"\x8a\x01\n\x18UpdateApplicationRequest\x12=\n\x0b\x61pplication\x18\x01 \x01(\x0b\x32(.google.cloud.talent.v4beta1.Application\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"(\n\x18\x44\x65leteApplicationRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"P\n\x17ListApplicationsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05"\xb4\x01\n\x18ListApplicationsResponse\x12>\n\x0c\x61pplications\x18\x01 \x03(\x0b\x32(.google.cloud.talent.v4beta1.Application\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\xc2\x08\n\x12\x41pplicationService\x12\xbf\x01\n\x11\x43reateApplication\x12\x35.google.cloud.talent.v4beta1.CreateApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"I\x82\xd3\xe4\x93\x02\x43">/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications:\x01*\x12\xb6\x01\n\x0eGetApplication\x12\x32.google.cloud.talent.v4beta1.GetApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"F\x82\xd3\xe4\x93\x02@\x12>/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}\x12\xcb\x01\n\x11UpdateApplication\x12\x35.google.cloud.talent.v4beta1.UpdateApplicationRequest\x1a(.google.cloud.talent.v4beta1.Application"U\x82\xd3\xe4\x93\x02O2J/v4beta1/{application.name=projects/*/tenants/*/profiles/*/applications/*}:\x01*\x12\xaa\x01\n\x11\x44\x65leteApplication\x12\x35.google.cloud.talent.v4beta1.DeleteApplicationRequest\x1a\x16.google.protobuf.Empty"F\x82\xd3\xe4\x93\x02@*>/v4beta1/{name=projects/*/tenants/*/profiles/*/applications/*}\x12\xc7\x01\n\x10ListApplications\x12\x34.google.cloud.talent.v4beta1.ListApplicationsRequest\x1a\x35.google.cloud.talent.v4beta1.ListApplicationsResponse"F\x82\xd3\xe4\x93\x02@\x12>/v4beta1/{parent=projects/*/tenants/*/profiles/*}/applications\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x85\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x17\x41pplicationServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_application__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_protobuf_dot_empty__pb2.DESCRIPTOR, @@ -98,8 +100,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=286, - serialized_end=391, + serialized_start=311, + serialized_end=416, ) @@ -137,8 +139,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=393, - serialized_end=430, + serialized_start=418, + serialized_end=455, ) @@ -194,8 +196,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=433, - serialized_end=571, + serialized_start=458, + serialized_end=596, ) @@ -233,8 +235,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=573, - serialized_end=613, + serialized_start=598, + serialized_end=638, ) @@ -308,8 +310,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=615, - serialized_end=695, + serialized_start=640, + serialized_end=720, ) @@ -383,8 +385,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=698, - serialized_end=878, + serialized_start=723, + serialized_end=903, ) _CREATEAPPLICATIONREQUEST.fields_by_name[ @@ -429,13 +431,13 @@ Attributes: parent: - Required. Resource name of the profile under which the + Required. Resource name of the profile under which the application is created. The format is "projects/{project\_id} /tenants/{tenant\_id}/profiles/{profile\_id}", for example, "projects/test-project/tenants/test-tenant/profiles/test- profile". application: - Required. The application to be created. + Required. The application to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateApplicationRequest) ), @@ -453,7 +455,7 @@ Attributes: name: - Required. The resource name of the application to be + Required. The resource name of the application to be retrieved. The format is "projects/{project\_id}/tenants/{ten ant\_id}/profiles/{profile\_id}/applications/{application\_id} ", for example, "projects/test-project/tenants/test- @@ -475,7 +477,7 @@ Attributes: application: - Required. The application resource to replace the current + Required. The application resource to replace the current resource in the system. update_mask: Optional but strongly recommended for the best service @@ -504,7 +506,7 @@ Attributes: name: - Required. The resource name of the application to be deleted. + Required. The resource name of the application to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/pro files/{profile\_id}/applications/{application\_id}", for example, "projects/test-project/tenants/test- @@ -526,16 +528,15 @@ Attributes: parent: - Required. Resource name of the profile under which the + Required. Resource name of the profile under which the application is created. The format is "projects/{project\_id} /tenants/{tenant\_id}/profiles/{profile\_id}", for example, "projects/test-project/tenants/test-tenant/profiles/test- profile". page_token: - Optional. The starting indicator from which to return - results. + Optional. The starting indicator from which to return results. page_size: - Optional. The maximum number of applications to be returned, + Optional. The maximum number of applications to be returned, at most 100. Default is 100 if a non-positive number is provided. """, @@ -577,9 +578,11 @@ full_name="google.cloud.talent.v4beta1.ApplicationService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=881, - serialized_end=1861, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=906, + serialized_end=1996, methods=[ _descriptor.MethodDescriptor( name="CreateApplication", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common.proto index 933ec28b1679..1513d795cd50 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common.proto @@ -567,9 +567,7 @@ message RequestMetadata { // The maximum number of allowed characters is 255. string user_id = 3; - // Optional. - // - // If set to `true`, + // 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 @@ -581,10 +579,8 @@ message RequestMetadata { // service experience. bool allow_missing_ids = 4; - // Optional. - // - // The type of device used by the job seeker at the time of the call to the - // service. + // Optional. The type of device used by the job seeker at the time of the call + // to the service. DeviceInfo device_info = 5; } @@ -627,14 +623,10 @@ message DeviceInfo { OTHER = 6; } - // Optional. - // - // Type of the device. + // Optional. Type of the device. DeviceType device_type = 1; - // Optional. - // - // A device-specific ID. The ID must be a unique identifier that + // Optional. A device-specific ID. The ID must be a unique identifier that // distinguishes the device from other devices. string id = 2; } @@ -669,10 +661,8 @@ message CustomAttribute { // supported. repeated int64 long_values = 2; - // Optional. - // - // If the `filterable` flag is true, custom field values are searchable. - // If false, values are not searchable. + // Optional. If the `filterable` flag is true, custom field values are + // searchable. If false, values are not searchable. // // Default is false. bool filterable = 3; @@ -715,17 +705,13 @@ message CompensationInfo { // times // [expected_units_per_year][google.cloud.talent.v4beta1.CompensationInfo.CompensationEntry.expected_units_per_year]. message CompensationEntry { - // Optional. - // - // Compensation type. + // Optional. Compensation type. // // Default is // [CompensationType.COMPENSATION_TYPE_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.COMPENSATION_TYPE_UNSPECIFIED]. CompensationType type = 1; - // Optional. - // - // Frequency of the specified amount. + // Optional. Frequency of the specified amount. // // Default is // [CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED]. @@ -735,27 +721,19 @@ message CompensationInfo { // // Compensation amount. It could be a fixed amount or a floating range. oneof compensation_amount { - // Optional. - // - // Compensation amount. + // Optional. Compensation amount. google.type.Money amount = 3; - // Optional. - // - // Compensation range. + // Optional. Compensation range. CompensationRange range = 4; } - // Optional. - // - // Compensation description. For example, could + // Optional. Compensation description. For example, could // indicate equity terms or provide additional context to an estimated // bonus. string description = 5; - // Optional. - // - // Expected number of units paid each year. If not specified, when + // 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]. @@ -770,19 +748,14 @@ message CompensationInfo { // Compensation range. message CompensationRange { - // Optional. - // - // The maximum amount of compensation. If left empty, the value is set - // to a maximal compensation value and the currency code is set to - // match the [currency code][google.type.Money.currency_code] of - // min_compensation. + // Optional. The maximum amount of compensation. If left empty, the value is + // set to a maximal compensation value and the currency code is set to match + // the [currency code][google.type.Money.currency_code] of min_compensation. google.type.Money max_compensation = 2; - // Optional. - // - // The minimum amount of compensation. If left empty, the value is set - // to zero and the currency code is set to match the - // [currency code][google.type.Money.currency_code] of max_compensation. + // Optional. The minimum amount of compensation. If left empty, the value is + // set to zero and the currency code is set to match the [currency + // code][google.type.Money.currency_code] of max_compensation. google.type.Money min_compensation = 1; } @@ -872,9 +845,7 @@ message CompensationInfo { OTHER_COMPENSATION_UNIT = 7; } - // Optional. - // - // Job compensation information. + // Optional. Job compensation information. // // At most one entry can be of type // [CompensationInfo.CompensationType.BASE][google.cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE], @@ -906,33 +877,23 @@ message CompensationInfo { // Resource that represents a license or certification. message Certification { - // Optional. - // - // Name of license or certification. + // Optional. Name of license or certification. // // Number of characters allowed is 100. string display_name = 1; - // Optional. - // - // Acquisition date or effective date of license or certification. + // Optional. Acquisition date or effective date of license or certification. google.type.Date acquire_date = 2; - // Optional. - // - // Expiration date of license of certification. + // Optional. Expiration date of license of certification. google.type.Date expire_date = 3; - // Optional. - // - // Authority of license, such as government. + // Optional. Authority of license, such as government. // // Number of characters allowed is 100. string authority = 4; - // Optional. - // - // Description of license or certification. + // Optional. Description of license or certification. // // Number of characters allowed is 100,000. string description = 5; @@ -940,29 +901,21 @@ message Certification { // Resource that represents a skill of a candidate. message Skill { - // Optional. - // - // Skill display name. + // Optional. Skill display name. // // For example, "Java", "Python". // // Number of characters allowed is 100. string display_name = 1; - // Optional. - // - // The last time this skill was used. + // Optional. The last time this skill was used. google.type.Date last_used_date = 2; - // Optional. - // - // Skill proficiency level which indicates how proficient the candidate is at - // this skill. + // Optional. Skill proficiency level which indicates how proficient the + // candidate is at this skill. SkillProficiencyLevel level = 3; - // Optional. - // - // A paragraph describes context of this skill. + // Optional. A paragraph describes context of this skill. // // Number of characters allowed is 100,000. string context = 4; @@ -977,15 +930,11 @@ message Skill { // Details of an interview. message Interview { - // Optional. - // - // The rating on this interview. + // Optional. The rating on this interview. Rating rating = 6; - // Required. - // - // The overall decision resulting from this interview (positive, negative, - // nuetral). + // Required. The overall decision resulting from this interview (positive, + // negative, nuetral). Outcome outcome = 7; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common_pb2.py index 90bc7b4aae06..6e6c09d822d3 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/common_pb2.py @@ -2461,7 +2461,7 @@ tenant site rely on this field being set correctly to a unique user ID. The maximum number of allowed characters is 255. allow_missing_ids: - Optional. If set to ``true``, + Optional. If set to ``true``, [domain][google.cloud.talent.v4beta1.RequestMetadata.domain], [session\_id][google.cloud.talent.v4beta1.RequestMetadata.sess ion\_id] and [user\_id][google.cloud.talent.v4beta1.RequestMet @@ -2473,7 +2473,7 @@ ion\_id] and [user\_id][google.cloud.talent.v4beta1.RequestMet adata.user\_id] for the best service experience. device_info: - Optional. The type of device used by the job seeker at the + Optional. The type of device used by the job seeker at the time of the call to the service. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.RequestMetadata) @@ -2514,9 +2514,9 @@ Attributes: device_type: - Optional. Type of the device. + Optional. Type of the device. id: - Optional. A device-specific ID. The ID must be a unique + Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.DeviceInfo) @@ -2555,7 +2555,7 @@ [google.cloud.talent.v4beta1.CustomAttribute.long\_values] is supported. filterable: - Optional. If the ``filterable`` flag is true, custom field + Optional. If the ``filterable`` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. """, @@ -2621,28 +2621,28 @@ Attributes: type: - Optional. Compensation type. Default is [CompensationType.CO - MPENSATION\_TYPE\_UNSPECIFIED][google.cloud.talent.v4beta1.Com - pensationInfo.CompensationType.COMPENSATION\_TYPE\_UNSPECIFIED - ]. + Optional. Compensation type. Default is [CompensationType.COM + PENSATION\_TYPE\_UNSPECIFIED][google.cloud.talent.v4beta1.Comp + ensationInfo.CompensationType.COMPENSATION\_TYPE\_UNSPECIFIED] + . unit: - Optional. Frequency of the specified amount. Default is [Com - pensationUnit.COMPENSATION\_UNIT\_UNSPECIFIED][google.cloud.ta - lent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION\_U - NIT\_UNSPECIFIED]. + Optional. Frequency of the specified amount. Default is [Comp + ensationUnit.COMPENSATION\_UNIT\_UNSPECIFIED][google.cloud.tal + ent.v4beta1.CompensationInfo.CompensationUnit.COMPENSATION\_UN + IT\_UNSPECIFIED]. compensation_amount: Optional. Compensation amount. It could be a fixed amount or a floating range. amount: - Optional. Compensation amount. + Optional. Compensation amount. range: - Optional. Compensation range. + Optional. Compensation range. description: - Optional. Compensation description. For example, could + Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. expected_units_per_year: - Optional. Expected number of units paid each year. If not + Optional. Expected number of units paid each year. If not specified, when [Job.employment\_types][google.cloud.talent.v4 beta1.Job.employment\_types] is FULLTIME, a default value is inferred based on [unit][google.cloud.talent.v4beta1.Compensat @@ -2663,12 +2663,12 @@ Attributes: max_compensation: - Optional. The maximum amount of compensation. If left empty, + Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the [currency code][google.type.Money.currency\_code] of min\_compensation. min_compensation: - Optional. The minimum amount of compensation. If left empty, + Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the [currency code][google.type.Money.currency\_code] of max\_compensation. @@ -2683,9 +2683,9 @@ Attributes: entries: - Optional. Job compensation information. At most one entry - can be of type [CompensationInfo.CompensationType.BASE][google - .cloud.talent.v4beta1.CompensationInfo.CompensationType.BASE], + Optional. Job compensation information. At most one entry can + be of type [CompensationInfo.CompensationType.BASE][google.clo + ud.talent.v4beta1.CompensationInfo.CompensationType.BASE], which is referred as **base compensation entry** for the job. annualized_base_compensation_range: Output only. Annualized base compensation range. Computed as @@ -2724,18 +2724,18 @@ Attributes: display_name: - Optional. Name of license or certification. Number of + Optional. Name of license or certification. Number of characters allowed is 100. acquire_date: - Optional. Acquisition date or effective date of license or + Optional. Acquisition date or effective date of license or certification. expire_date: - Optional. Expiration date of license of certification. + Optional. Expiration date of license of certification. authority: - Optional. Authority of license, such as government. Number - of characters allowed is 100. + Optional. Authority of license, such as government. Number of + characters allowed is 100. description: - Optional. Description of license or certification. Number of + Optional. Description of license or certification. Number of characters allowed is 100,000. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Certification) @@ -2754,16 +2754,16 @@ Attributes: display_name: - Optional. Skill display name. For example, "Java", "Python". + Optional. Skill display name. For example, "Java", "Python". Number of characters allowed is 100. last_used_date: - Optional. The last time this skill was used. + Optional. The last time this skill was used. level: - Optional. Skill proficiency level which indicates how + Optional. Skill proficiency level which indicates how proficient the candidate is at this skill. context: - Optional. A paragraph describes context of this skill. - Number of characters allowed is 100,000. + Optional. A paragraph describes context of this skill. Number + of characters allowed is 100,000. skill_name_snippet: Output only. Skill name snippet shows how the [display\_name][ google.cloud.talent.v4beta1.Skill.display\_name] is related to @@ -2787,9 +2787,9 @@ Attributes: rating: - Optional. The rating on this interview. + Optional. The rating on this interview. outcome: - Required. The overall decision resulting from this interview + Required. The overall decision resulting from this interview (positive, negative, nuetral). """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Interview) diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company.proto index 4c6712bd32f9..928a43822bf3 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company.proto @@ -51,72 +51,52 @@ message Company { // example, "projects/api-test-project/companies/bar". string name = 1; - // Required. - // - // The display name of the company, for example, "Google, LLC". + // Required. The display name of the company, for example, "Google, LLC". string display_name = 2; - // Required. - // - // Client side company identifier, used to uniquely identify the + // Required. Client side company identifier, used to uniquely identify the // company. // // The maximum number of allowed characters is 255. string external_id = 3; - // Optional. - // - // The employer's company size. + // Optional. The employer's company size. CompanySize size = 4; - // Optional. - // - // 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 + // Optional. 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]. string headquarters_address = 5; - // Optional. - // - // Set to true if it is the hiring agency that post jobs for other + // Optional. Set to true if it is the hiring agency that post jobs for other // employers. // // Defaults to false if not provided. bool hiring_agency = 6; - // Optional. - // - // Equal Employment Opportunity legal disclaimer text to be + // Optional. Equal Employment Opportunity legal disclaimer text to be // associated with all jobs, and typically to be displayed in all // roles. // // The maximum number of allowed characters is 500. string eeo_text = 7; - // Optional. - // - // The URI representing the company's primary web site or home page, + // Optional. The URI representing the company's primary web site or home page, // for example, "https://www.google.com". // // The maximum number of allowed characters is 255. string website_uri = 8; - // Optional. - // - // The URI to employer's career site or careers page on the employer's web - // site, for example, "https://careers.google.com". + // Optional. The URI to employer's career site or careers page on the + // employer's web site, for example, "https://careers.google.com". string career_site_uri = 9; - // Optional. - // - // A URI that hosts the employer's company logo. + // Optional. A URI that hosts the employer's company logo. string image_uri = 10; - // Optional. - // - // A list of keys of filterable + // 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 searches. Jobs with // `string_values` under these specified field keys are returned if any diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_pb2.py index 4a05c217de9e..3be1be842685 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_pb2.py @@ -384,42 +384,42 @@ optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". display_name: - Required. The display name of the company, for example, + Required. The display name of the company, for example, "Google, LLC". external_id: - Required. Client side company identifier, used to uniquely + Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. size: - Optional. The employer's company size. + Optional. The employer's company size. headquarters_address: - Optional. The street address of the company's main + Optional. 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 [Deriv edInfo.headquarters\_location][google.cloud.talent.v4beta1.Com pany.DerivedInfo.headquarters\_location]. hiring_agency: - Optional. Set to true if it is the hiring agency that post + Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. eeo_text: - Optional. Equal Employment Opportunity legal disclaimer text + Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. website_uri: - Optional. The URI representing the company's primary web site + Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. career_site_uri: - Optional. The URI to employer's career site or careers page - on the employer's web site, for example, + Optional. The URI to employer's career site or careers page on + the employer's web site, for example, "https://careers.google.com". image_uri: - Optional. A URI that hosts the employer's company logo. + Optional. A URI that hosts the employer's company logo. keyword_searchable_job_custom_attributes: - Optional. A list of keys of filterable [Job.custom\_attribute - s][google.cloud.talent.v4beta1.Job.custom\_attributes], whose + 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 searches. Jobs with ``string_values`` under these specified field keys are returned if any of the values match the search keyword. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service.proto index 8af4b9ad4bb9..1e48a46cd5b3 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/common.proto"; import "google/cloud/talent/v4beta1/company.proto"; import "google/protobuf/empty.proto"; @@ -31,6 +32,11 @@ option objc_class_prefix = "CTS"; // A service that handles company management, including CRUD and enumeration. service CompanyService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Creates a new company entity. rpc CreateCompany(CreateCompanyRequest) returns (Company) { option (google.api.http) = { @@ -47,9 +53,7 @@ service CompanyService { rpc GetCompany(GetCompanyRequest) returns (Company) { option (google.api.http) = { get: "/v4beta1/{name=projects/*/tenants/*/companies/*}" - additional_bindings { - get: "/v4beta1/{name=projects/*/companies/*}" - } + additional_bindings { get: "/v4beta1/{name=projects/*/companies/*}" } }; } @@ -70,9 +74,7 @@ service CompanyService { rpc DeleteCompany(DeleteCompanyRequest) returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v4beta1/{name=projects/*/tenants/*/companies/*}" - additional_bindings { - delete: "/v4beta1/{name=projects/*/companies/*}" - } + additional_bindings { delete: "/v4beta1/{name=projects/*/companies/*}" } }; } @@ -80,18 +82,14 @@ service CompanyService { rpc ListCompanies(ListCompaniesRequest) returns (ListCompaniesResponse) { option (google.api.http) = { get: "/v4beta1/{parent=projects/*/tenants/*}/companies" - additional_bindings { - get: "/v4beta1/{parent=projects/*}/companies" - } + additional_bindings { get: "/v4beta1/{parent=projects/*}/companies" } }; } } // The Request of the CreateCompany method. message CreateCompanyRequest { - // Required. - // - // Resource name of the tenant under which the company is created. + // Required. Resource name of the tenant under which the company is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -100,17 +98,13 @@ message CreateCompanyRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The company to be created. + // Required. The company to be created. Company company = 2; } // Request for getting a company by name. message GetCompanyRequest { - // Required. - // - // The resource name of the company to be retrieved. + // Required. The resource name of the company to be retrieved. // // The format is // "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for @@ -123,27 +117,28 @@ message GetCompanyRequest { // Request for updating a specified company. message UpdateCompanyRequest { - // Required. - // - // The company resource to replace the current resource in the system. + // Required. The company resource to replace the current resource in the + // system. Company company = 1; // Optional but strongly recommended for the best service // experience. // - // If [update_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.update_mask] is provided, only the specified fields in - // [company][google.cloud.talent.v4beta1.UpdateCompanyRequest.company] are updated. Otherwise all the fields are updated. + // If + // [update_mask][google.cloud.talent.v4beta1.UpdateCompanyRequest.update_mask] + // is provided, only the specified fields in + // [company][google.cloud.talent.v4beta1.UpdateCompanyRequest.company] are + // updated. Otherwise all the fields are updated. // // A field mask to specify the company fields to be updated. Only - // top level fields of [Company][google.cloud.talent.v4beta1.Company] are supported. + // top level fields of [Company][google.cloud.talent.v4beta1.Company] are + // supported. google.protobuf.FieldMask update_mask = 2; } // Request to delete a company. message DeleteCompanyRequest { - // Required. - // - // The resource name of the company to be deleted. + // Required. The resource name of the company to be deleted. // // The format is // "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for @@ -156,9 +151,7 @@ message DeleteCompanyRequest { // List companies for which the client has ACL visibility. message ListCompaniesRequest { - // Required. - // - // Resource name of the tenant under which the company is created. + // Required. Resource name of the tenant under which the company is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -167,25 +160,20 @@ message ListCompaniesRequest { // example, "projects/api-test-project". string parent = 1; - // Optional. - // - // The starting indicator from which to return results. + // Optional. The starting indicator from which to return results. string page_token = 2; - // Optional. - // - // The maximum number of companies to be returned, at most 100. + // Optional. The maximum number of companies to be returned, at most 100. // Default is 100 if a non-positive number is provided. int32 page_size = 3; - // Optional. - // - // Set to true if the companies requested must have open jobs. + // Optional. Set to true if the companies requested must have open jobs. // // Defaults to false. // - // If true, at most [page_size][google.cloud.talent.v4beta1.ListCompaniesRequest.page_size] of companies are fetched, among which - // only those with open jobs are returned. + // If true, at most + // [page_size][google.cloud.talent.v4beta1.ListCompaniesRequest.page_size] of + // companies are fetched, among which only those with open jobs are returned. bool require_open_jobs = 4; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service_pb2.py index 0942e576706e..a1247cbbe1ef 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/company_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( common_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2, ) @@ -34,10 +35,11 @@ "\n\037com.google.cloud.talent.v4beta1B\023CompanyServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n7google/cloud/talent_v4beta1/proto/company_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/company.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"]\n\x14\x43reateCompanyRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x35\n\x07\x63ompany\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Company"!\n\x11GetCompanyRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"~\n\x14UpdateCompanyRequest\x12\x35\n\x07\x63ompany\x18\x01 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Company\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"$\n\x14\x44\x65leteCompanyRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"h\n\x14ListCompaniesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x19\n\x11require_open_jobs\x18\x04 \x01(\x08"\xaa\x01\n\x15ListCompaniesResponse\x12\x37\n\tcompanies\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Company\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\xb1\x08\n\x0e\x43ompanyService\x12\xd2\x01\n\rCreateCompany\x12\x31.google.cloud.talent.v4beta1.CreateCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"h\x82\xd3\xe4\x93\x02\x62"0/v4beta1/{parent=projects/*/tenants/*}/companies:\x01*Z+"&/v4beta1/{parent=projects/*}/companies:\x01*\x12\xc6\x01\n\nGetCompany\x12..google.cloud.talent.v4beta1.GetCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"b\x82\xd3\xe4\x93\x02\\\x12\x30/v4beta1/{name=projects/*/tenants/*/companies/*}Z(\x12&/v4beta1/{name=projects/*/companies/*}\x12\xe2\x01\n\rUpdateCompany\x12\x31.google.cloud.talent.v4beta1.UpdateCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"x\x82\xd3\xe4\x93\x02r28/v4beta1/{company.name=projects/*/tenants/*/companies/*}:\x01*Z32./v4beta1/{company.name=projects/*/companies/*}:\x01*\x12\xbe\x01\n\rDeleteCompany\x12\x31.google.cloud.talent.v4beta1.DeleteCompanyRequest\x1a\x16.google.protobuf.Empty"b\x82\xd3\xe4\x93\x02\\*0/v4beta1/{name=projects/*/tenants/*/companies/*}Z(*&/v4beta1/{name=projects/*/companies/*}\x12\xda\x01\n\rListCompanies\x12\x31.google.cloud.talent.v4beta1.ListCompaniesRequest\x1a\x32.google.cloud.talent.v4beta1.ListCompaniesResponse"b\x82\xd3\xe4\x93\x02\\\x12\x30/v4beta1/{parent=projects/*/tenants/*}/companiesZ(\x12&/v4beta1/{parent=projects/*}/companiesB\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13\x43ompanyServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n7google/cloud/talent_v4beta1/proto/company_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/company.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"]\n\x14\x43reateCompanyRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x35\n\x07\x63ompany\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Company"!\n\x11GetCompanyRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"~\n\x14UpdateCompanyRequest\x12\x35\n\x07\x63ompany\x18\x01 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Company\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"$\n\x14\x44\x65leteCompanyRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"h\n\x14ListCompaniesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12\x19\n\x11require_open_jobs\x18\x04 \x01(\x08"\xaa\x01\n\x15ListCompaniesResponse\x12\x37\n\tcompanies\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Company\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\x9f\t\n\x0e\x43ompanyService\x12\xd2\x01\n\rCreateCompany\x12\x31.google.cloud.talent.v4beta1.CreateCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"h\x82\xd3\xe4\x93\x02\x62"0/v4beta1/{parent=projects/*/tenants/*}/companies:\x01*Z+"&/v4beta1/{parent=projects/*}/companies:\x01*\x12\xc6\x01\n\nGetCompany\x12..google.cloud.talent.v4beta1.GetCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"b\x82\xd3\xe4\x93\x02\\\x12\x30/v4beta1/{name=projects/*/tenants/*/companies/*}Z(\x12&/v4beta1/{name=projects/*/companies/*}\x12\xe2\x01\n\rUpdateCompany\x12\x31.google.cloud.talent.v4beta1.UpdateCompanyRequest\x1a$.google.cloud.talent.v4beta1.Company"x\x82\xd3\xe4\x93\x02r28/v4beta1/{company.name=projects/*/tenants/*/companies/*}:\x01*Z32./v4beta1/{company.name=projects/*/companies/*}:\x01*\x12\xbe\x01\n\rDeleteCompany\x12\x31.google.cloud.talent.v4beta1.DeleteCompanyRequest\x1a\x16.google.protobuf.Empty"b\x82\xd3\xe4\x93\x02\\*0/v4beta1/{name=projects/*/tenants/*/companies/*}Z(*&/v4beta1/{name=projects/*/companies/*}\x12\xda\x01\n\rListCompanies\x12\x31.google.cloud.talent.v4beta1.ListCompaniesRequest\x1a\x32.google.cloud.talent.v4beta1.ListCompaniesResponse"b\x82\xd3\xe4\x93\x02\\\x12\x30/v4beta1/{parent=projects/*/tenants/*}/companiesZ(\x12&/v4beta1/{parent=projects/*}/companies\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13\x43ompanyServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_company__pb2.DESCRIPTOR, google_dot_protobuf_dot_empty__pb2.DESCRIPTOR, @@ -98,8 +100,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=278, - serialized_end=371, + serialized_start=303, + serialized_end=396, ) @@ -137,8 +139,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=373, - serialized_end=406, + serialized_start=398, + serialized_end=431, ) @@ -194,8 +196,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=408, - serialized_end=534, + serialized_start=433, + serialized_end=559, ) @@ -233,8 +235,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=536, - serialized_end=572, + serialized_start=561, + serialized_end=597, ) @@ -326,8 +328,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=574, - serialized_end=678, + serialized_start=599, + serialized_end=703, ) @@ -401,8 +403,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=681, - serialized_end=851, + serialized_start=706, + serialized_end=876, ) _CREATECOMPANYREQUEST.fields_by_name[ @@ -447,14 +449,14 @@ Attributes: parent: - Required. Resource name of the tenant under which the company + Required. Resource name of the tenant under which the company is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". company: - Required. The company to be created. + Required. The company to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateCompanyRequest) ), @@ -472,7 +474,7 @@ Attributes: name: - Required. The resource name of the company to be retrieved. + Required. The resource name of the company to be retrieved. The format is "projects/{project\_id}/tenants/{tenant\_id}/com panies/{company\_id}", for example, "projects/api-test- project/tenants/foo/companies/bar". Tenant id is optional and @@ -495,8 +497,8 @@ Attributes: company: - Required. The company resource to replace the current - resource in the system. + Required. The company resource to replace the current resource + in the system. update_mask: Optional but strongly recommended for the best service experience. If [update\_mask][google.cloud.talent.v4beta1.Upd @@ -523,9 +525,9 @@ Attributes: name: - Required. The resource name of the company to be deleted. - The format is "projects/{project\_id}/tenants/{tenant\_id}/com - panies/{company\_id}", for example, "projects/api-test- + Required. The resource name of the company to be deleted. The + format is "projects/{project\_id}/tenants/{tenant\_id}/compani + es/{company\_id}", for example, "projects/api-test- project/tenants/foo/companies/bar". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". @@ -546,20 +548,19 @@ Attributes: parent: - Required. Resource name of the tenant under which the company + Required. Resource name of the tenant under which the company is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". page_token: - Optional. The starting indicator from which to return - results. + Optional. The starting indicator from which to return results. page_size: - Optional. The maximum number of companies to be returned, at + Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. require_open_jobs: - Optional. Set to true if the companies requested must have + Optional. Set to true if the companies requested must have open jobs. Defaults to false. If true, at most [page\_size][ google.cloud.talent.v4beta1.ListCompaniesRequest.page\_size] of companies are fetched, among which only those with open @@ -603,9 +604,11 @@ full_name="google.cloud.talent.v4beta1.CompanyService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=854, - serialized_end=1927, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=879, + serialized_end=2062, methods=[ _descriptor.MethodDescriptor( name="CreateCompany", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service.proto index af7df1c4ec3c..2b105c24beaf 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/common.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent"; @@ -28,6 +29,11 @@ option objc_class_prefix = "CTS"; // A service handles auto completion. service Completion { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Completes the specified prefix with keyword suggestions. // Intended for use by a job search auto-complete search box. rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) { @@ -70,9 +76,7 @@ message CompleteQueryRequest { COMBINED = 3; } - // Required. - // - // Resource name of tenant the completion is performed within. + // Required. Resource name of tenant the completion is performed within. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -81,16 +85,12 @@ message CompleteQueryRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The query used to generate suggestions. + // Required. The query used to generate suggestions. // // The maximum number of allowed characters is 255. string query = 2; - // Optional. - // - // The list of languages of the query. This is + // Optional. The list of languages of the query. This is // the BCP-47 language code, such as "en-US" or "sr-Latn". // For more information, see // [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). @@ -118,16 +118,12 @@ message CompleteQueryRequest { // The maximum number of allowed characters is 255. repeated string language_codes = 3; - // Required. - // - // Completion result count. + // Required. Completion result count. // // The maximum allowed page size is 10. int32 page_size = 4; - // Optional. - // - // If provided, restricts completion to specified company. + // Optional. If provided, restricts completion to specified company. // // The format is // "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for @@ -137,15 +133,11 @@ message CompleteQueryRequest { // example, "projects/api-test-project/companies/bar". string company = 5; - // Optional. - // - // The scope of the completion. The defaults is + // Optional. The scope of the completion. The defaults is // [CompletionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope.PUBLIC]. CompletionScope scope = 6; - // Optional. - // - // The completion topic. The default is + // Optional. The completion topic. The default is // [CompletionType.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType.COMBINED]. CompletionType type = 7; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service_pb2.py index 6e6e1e0d4bc6..c62fde7c4329 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/completion_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( common_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2, ) @@ -29,10 +30,11 @@ "\n\037com.google.cloud.talent.v4beta1B\026CompletionServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n:google/cloud/talent_v4beta1/proto/completion_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto"\xc2\x03\n\x14\x43ompleteQueryRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\r\n\x05query\x18\x02 \x01(\t\x12\x16\n\x0elanguage_codes\x18\x03 \x03(\t\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x0f\n\x07\x63ompany\x18\x05 \x01(\t\x12P\n\x05scope\x18\x06 \x01(\x0e\x32\x41.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope\x12N\n\x04type\x18\x07 \x01(\x0e\x32@.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType"K\n\x0f\x43ompletionScope\x12 \n\x1c\x43OMPLETION_SCOPE_UNSPECIFIED\x10\x00\x12\n\n\x06TENANT\x10\x01\x12\n\n\x06PUBLIC\x10\x02"`\n\x0e\x43ompletionType\x12\x1f\n\x1b\x43OMPLETION_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tJOB_TITLE\x10\x01\x12\x10\n\x0c\x43OMPANY_NAME\x10\x02\x12\x0c\n\x08\x43OMBINED\x10\x03"\xc5\x02\n\x15\x43ompleteQueryResponse\x12_\n\x12\x63ompletion_results\x18\x01 \x03(\x0b\x32\x43.google.cloud.talent.v4beta1.CompleteQueryResponse.CompletionResult\x12?\n\x08metadata\x18\x02 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x1a\x89\x01\n\x10\x43ompletionResult\x12\x12\n\nsuggestion\x18\x01 \x01(\t\x12N\n\x04type\x18\x02 \x01(\x0e\x32@.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType\x12\x11\n\timage_uri\x18\x03 \x01(\t2\xe7\x01\n\nCompletion\x12\xd8\x01\n\rCompleteQuery\x12\x31.google.cloud.talent.v4beta1.CompleteQueryRequest\x1a\x32.google.cloud.talent.v4beta1.CompleteQueryResponse"`\x82\xd3\xe4\x93\x02Z\x12//v4beta1/{parent=projects/*/tenants/*}:completeZ\'\x12%/v4beta1/{parent=projects/*}:completeB\x84\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x16\x43ompletionServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n:google/cloud/talent_v4beta1/proto/completion_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto"\xc2\x03\n\x14\x43ompleteQueryRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\r\n\x05query\x18\x02 \x01(\t\x12\x16\n\x0elanguage_codes\x18\x03 \x03(\t\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x0f\n\x07\x63ompany\x18\x05 \x01(\t\x12P\n\x05scope\x18\x06 \x01(\x0e\x32\x41.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionScope\x12N\n\x04type\x18\x07 \x01(\x0e\x32@.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType"K\n\x0f\x43ompletionScope\x12 \n\x1c\x43OMPLETION_SCOPE_UNSPECIFIED\x10\x00\x12\n\n\x06TENANT\x10\x01\x12\n\n\x06PUBLIC\x10\x02"`\n\x0e\x43ompletionType\x12\x1f\n\x1b\x43OMPLETION_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tJOB_TITLE\x10\x01\x12\x10\n\x0c\x43OMPANY_NAME\x10\x02\x12\x0c\n\x08\x43OMBINED\x10\x03"\xc5\x02\n\x15\x43ompleteQueryResponse\x12_\n\x12\x63ompletion_results\x18\x01 \x03(\x0b\x32\x43.google.cloud.talent.v4beta1.CompleteQueryResponse.CompletionResult\x12?\n\x08metadata\x18\x02 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x1a\x89\x01\n\x10\x43ompletionResult\x12\x12\n\nsuggestion\x18\x01 \x01(\t\x12N\n\x04type\x18\x02 \x01(\x0e\x32@.google.cloud.talent.v4beta1.CompleteQueryRequest.CompletionType\x12\x11\n\timage_uri\x18\x03 \x01(\t2\xd5\x02\n\nCompletion\x12\xd8\x01\n\rCompleteQuery\x12\x31.google.cloud.talent.v4beta1.CompleteQueryRequest\x1a\x32.google.cloud.talent.v4beta1.CompleteQueryResponse"`\x82\xd3\xe4\x93\x02Z\x12//v4beta1/{parent=projects/*/tenants/*}:completeZ\'\x12%/v4beta1/{parent=projects/*}:complete\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x84\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x16\x43ompletionServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, ], ) @@ -60,8 +62,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=447, - serialized_end=522, + serialized_start=472, + serialized_end=547, ) _sym_db.RegisterEnumDescriptor(_COMPLETEQUERYREQUEST_COMPLETIONSCOPE) @@ -90,8 +92,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=524, - serialized_end=620, + serialized_start=549, + serialized_end=645, ) _sym_db.RegisterEnumDescriptor(_COMPLETEQUERYREQUEST_COMPLETIONTYPE) @@ -241,8 +243,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=170, - serialized_end=620, + serialized_start=195, + serialized_end=645, ) @@ -316,8 +318,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=811, - serialized_end=948, + serialized_start=836, + serialized_end=973, ) _COMPLETEQUERYRESPONSE = _descriptor.Descriptor( @@ -372,8 +374,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=623, - serialized_end=948, + serialized_start=648, + serialized_end=973, ) _COMPLETEQUERYREQUEST.fields_by_name[ @@ -413,17 +415,17 @@ Attributes: parent: - Required. Resource name of tenant the completion is performed + Required. Resource name of tenant the completion is performed within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". query: - Required. The query used to generate suggestions. The - maximum number of allowed characters is 255. + Required. The query used to generate suggestions. The maximum + number of allowed characters is 255. language_codes: - Optional. The list of languages of the query. This is the + Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see `Tags for Identifying Languages `__. For [CompletionType.J @@ -443,23 +445,23 @@ eQueryRequest.language\_codes] are returned. The maximum number of allowed characters is 255. page_size: - Required. Completion result count. The maximum allowed page + Required. Completion result count. The maximum allowed page size is 10. company: - Optional. If provided, restricts completion to specified + Optional. If provided, restricts completion to specified company. The format is "projects/{project\_id}/tenants/{tenan t\_id}/companies/{company\_id}", for example, "projects/api- test-project/tenants/foo/companies/bar". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". scope: - Optional. The scope of the completion. The defaults is [Compl - etionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryRe - quest.CompletionScope.PUBLIC]. + Optional. The scope of the completion. The defaults is [Comple + tionScope.PUBLIC][google.cloud.talent.v4beta1.CompleteQueryReq + uest.CompletionScope.PUBLIC]. type: - Optional. The completion topic. The default is [CompletionTyp - e.COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.C - ompletionType.COMBINED]. + Optional. The completion topic. The default is [CompletionType + .COMBINED][google.cloud.talent.v4beta1.CompleteQueryRequest.Co + mpletionType.COMBINED]. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CompleteQueryRequest) ), @@ -522,9 +524,11 @@ full_name="google.cloud.talent.v4beta1.Completion", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=951, - serialized_end=1182, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=976, + serialized_end=1317, methods=[ _descriptor.MethodDescriptor( name="CompleteQuery", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event.proto index 5d2f893dcb6c..c8ea12581e22 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event.proto @@ -28,7 +28,7 @@ option objc_class_prefix = "CTS"; // An event issued when an end user interacts with the application that // implements Cloud Talent Solution. Providing this information improves the -// quality of search and recommendation for the API clients, enabling the +// quality of results for the API clients, enabling the // service to perform optimally. The number of events sent must be consistent // with other calls, such as job searches, issued to the service by the client. message ClientEvent { @@ -38,14 +38,10 @@ message ClientEvent { // [ResponseMetadata.request_id][google.cloud.talent.v4beta1.ResponseMetadata.request_id]. string request_id = 1; - // Required. - // - // A unique identifier, generated by the client application. + // Required. A unique identifier, generated by the client application. string event_id = 2; - // Required. - // - // The timestamp of the event. + // Required. The timestamp of the event. google.protobuf.Timestamp create_time = 4; // Required. @@ -61,10 +57,8 @@ message ClientEvent { ProfileEvent profile_event = 6; } - // Optional. - // - // Notes about the event provided by recruiters or other users, for example, - // feedback on why a profile was bookmarked. + // Optional. Notes about the event provided by recruiters or other users, for + // example, feedback on why a profile was bookmarked. string event_notes = 9; } @@ -171,16 +165,12 @@ message JobEvent { INTERVIEW_GRANTED = 15; } - // Required. - // - // The type of the event (see + // Required. The type of the event (see // [JobEventType][google.cloud.talent.v4beta1.JobEvent.JobEventType]). JobEventType type = 1; - // Required. - // - // The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with - // this event. For example, if this is an + // Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] + // associated with this event. For example, if this is an // [impression][google.cloud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] // event, this field contains the identifiers of all jobs shown to the job // seeker. If this was a @@ -192,10 +182,8 @@ message JobEvent { // example, "projects/api-test-project/tenants/foo/jobs/1234". repeated string jobs = 2; - // Optional. - // - // The [profile name][google.cloud.talent.v4beta1.Profile.name] associated - // with this client event. + // Optional. The [profile name][google.cloud.talent.v4beta1.Profile.name] + // associated with this client event. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", @@ -211,35 +199,102 @@ message ProfileEvent { // Default value. PROFILE_EVENT_TYPE_UNSPECIFIED = 0; - // The profile is displayed. + // Send this event when a + // [ProfileEvent.profiles][google.cloud.talent.v4beta1.ProfileEvent.profiles] + // meets all of the following criteria: + // * Was sent as a part of a result set for a CTS API call. + // * Was rendered in the end user's UI (that is, the + // [ProfileEvent.recruiter][google.cloud.talent.v4beta1.ProfileEvent.recruiter]). + // * That UI rendering was displayed in the end user's viewport for >=3 + // seconds. + // + // In other words, send this event when the end user of the CTS service + // actually saw a resulting profile in their viewport. + // + // To understand how to use this event, consider an example: + // + // * The customer's UI for interacting with CTS + // result sets is accessed by the end user through a web browser. + // * The UI calls for a page size of 15 candidates (that is, 15 candidates + // are rendered on each page of results). + // * However, the UI design calls for only 5 candidates to be shown at any + // given time in the viewport (that is, the end user can only see 5 results + // at any given time and needs to scroll up or down to view all 15 results). + // + // To render each page of results, the customer will send a + // request to CTS with a page size = 15. + // + // * User loads page #1 of results. + // * User scrolls down to expose results #1 - #5 and dwells on this view for + // 30 seconds. + // * Send an IMPRESSION event for result 1, 2, 3, 4, 5. + // * User scrolls down a bit, exposing results #2 - #6 in the viewport and + // dwells on this view for 5 minutes. + // * Send an IMPRESSION event for result 6. + // * User scrolls to the bottom of the page, with results #7 - #15 shown in + // the viewport for ~5 seconds each. + // * Specifically, NO IMPRESSION events are sent for result 7, 8, 9, 10, 11, + // 12, 13, 14, 15. + // * User clicks to the next page and loads page #2 of results. + // * Within 2 seconds, user scrolls to expose results #20 - #24 in the + // viewport and dwells on this view for 20 mins. + // * Send an IMPRESSION event for result 20, 21, 22, 23, 24 + // * User closes their browser window. IMPRESSION = 1; - // The profile is viewed. + // The VIEW event allows CTS to understand if a candidate's profile was + // viewed by an end user (that is, recruiter) of the system for >=3 seconds. + // This is critical to tracking product metrics and should be sent for every + // profile VIEW that happens in the customer's system. + // + // VIEW events should be sent whether an end user views a candidate's + // profile as a result of seeing that profile in the result set of a + // CTS API request or whether the end user + // views the profile for some other reason (that is, clicks to the + // candidate's profile in the ATS, and so on). + // + // For a VIEW that happens as a result of seeing the profile in + // a CTS API request's result set, the + // [ClientEvent.request_id][google.cloud.talent.v4beta1.ClientEvent.request_id] + // should be populated. If the VIEW happens for some other reason, the + // [requestId] should not be populated. + // + // This event requires a valid recruiter and one valid ID in profiles. + // + // To understand how to use this event, consider 2 examples in which a VIEW + // event should be sent: + // * End user makes a request to the CTS API for a result set. + // * Results for the request are shown to the end user. + // * End user clicks on one of the candidates that are shown as part of the + // results. + // * A VIEW event with the + // [ClientEvent.request_id][google.cloud.talent.v4beta1.ClientEvent.request_id] + // of the API call in the first step of this example is sent. + // + // * End user browses to a candidate's profile in the ATS. + // * A VIEW event without a + // [ClientEvent.request_id][google.cloud.talent.v4beta1.ClientEvent.request_id] + // is sent. VIEW = 2; // The profile is bookmarked. BOOKMARK = 3; } - // Required. - // - // Type of event. + // Required. Type of event. ProfileEventType type = 1; - // Required. - // - // The [profile name(s)][google.cloud.talent.v4beta1.Profile.name] associated - // with this client event. + // Required. The [profile name(s)][google.cloud.talent.v4beta1.Profile.name] + // associated with this client event. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", // for example, "projects/api-test-project/tenants/foo/profiles/bar". repeated string profiles = 2; - // Optional. - // - // The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with - // this client event. Leave it empty if the event isn't associated with a job. + // Optional. The [job name(s)][google.cloud.talent.v4beta1.Job.name] + // associated with this client event. Leave it empty if the event isn't + // associated with a job. // // The format is // "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_pb2.py index 31f8fceed27e..d505d739c101 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_pb2.py @@ -485,10 +485,9 @@ __module__="google.cloud.talent_v4beta1.proto.event_pb2", __doc__="""An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves - the quality of search and recommendation for the API clients, enabling - the service to perform optimally. The number of events sent must be - consistent with other calls, such as job searches, issued to the service - by the client. + the quality of results for the API clients, enabling the service to + perform optimally. The number of events sent must be consistent with + other calls, such as job searches, issued to the service by the client. Attributes: @@ -497,10 +496,10 @@ API responses. It can be found in [ResponseMetadata.request\_i d][google.cloud.talent.v4beta1.ResponseMetadata.request\_id]. event_id: - Required. A unique identifier, generated by the client + Required. A unique identifier, generated by the client application. create_time: - Required. The timestamp of the event. + Required. The timestamp of the event. event: Required. The detail information of a specific event type. job_event: @@ -510,7 +509,7 @@ An event issued when a profile searcher interacts with the application that implements Cloud Talent Solution. event_notes: - Optional. Notes about the event provided by recruiters or + Optional. Notes about the event provided by recruiters or other users, for example, feedback on why a profile was bookmarked. """, @@ -531,10 +530,10 @@ Attributes: type: - Required. The type of the event (see [JobEventType][google.cl - oud.talent.v4beta1.JobEvent.JobEventType]). + Required. The type of the event (see [JobEventType][google.clo + ud.talent.v4beta1.JobEvent.JobEventType]). jobs: - Required. The [job + Required. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this event. For example, if this is an [impression][google.clo ud.talent.v4beta1.JobEvent.JobEventType.IMPRESSION] event, @@ -547,7 +546,7 @@ for example, "projects/api-test- project/tenants/foo/jobs/1234". profile: - Optional. The [profile + Optional. The [profile name][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is "projects/{project\_id} /tenants/{tenant\_id}/profiles/{profile\_id}", for example, @@ -570,15 +569,15 @@ Attributes: type: - Required. Type of event. + Required. Type of event. profiles: - Required. The [profile + Required. The [profile name(s)][google.cloud.talent.v4beta1.Profile.name] associated with this client event. The format is "projects/{project\_id} /tenants/{tenant\_id}/profiles/{profile\_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar". jobs: - Optional. The [job + Optional. The [job name(s)][google.cloud.talent.v4beta1.Job.name] associated with this client event. Leave it empty if the event isn't associated with a job. The format is diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service.proto index d456336d9ac2..966632e57d2e 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/event.proto"; option go_package = "google.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent"; @@ -28,6 +29,11 @@ option objc_class_prefix = "CTS"; // A service handles client event report. service EventService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Report events issued when end user interacts with customer's application // that uses Cloud Talent Solution. You may inspect the created events in // [self service @@ -49,9 +55,7 @@ service EventService { // The report event request. message CreateClientEventRequest { - // Required. - // - // Resource name of the tenant under which the event is created. + // Required. Resource name of the tenant under which the event is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -60,9 +64,7 @@ message CreateClientEventRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // Events issued when end user interacts with customer's application that - // uses Cloud Talent Solution. + // Required. Events issued when end user interacts with customer's application + // that uses Cloud Talent Solution. ClientEvent client_event = 2; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service_pb2.py index cc6cbc4e1ab0..7cf0778adcc7 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/event_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( event_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_event__pb2, ) @@ -29,10 +30,11 @@ "\n\037com.google.cloud.talent.v4beta1B\021EventServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n5google/cloud/talent_v4beta1/proto/event_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a-google/cloud/talent_v4beta1/proto/event.proto"j\n\x18\x43reateClientEventRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12>\n\x0c\x63lient_event\x18\x02 \x01(\x0b\x32(.google.cloud.talent.v4beta1.ClientEvent2\xf5\x01\n\x0c\x45ventService\x12\xe4\x01\n\x11\x43reateClientEvent\x12\x35.google.cloud.talent.v4beta1.CreateClientEventRequest\x1a(.google.cloud.talent.v4beta1.ClientEvent"n\x82\xd3\xe4\x93\x02h"3/v4beta1/{parent=projects/*/tenants/*}/clientEvents:\x01*Z.")/v4beta1/{parent=projects/*}/clientEvents:\x01*B\x7f\n\x1f\x63om.google.cloud.talent.v4beta1B\x11\x45ventServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n5google/cloud/talent_v4beta1/proto/event_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a-google/cloud/talent_v4beta1/proto/event.proto"j\n\x18\x43reateClientEventRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12>\n\x0c\x63lient_event\x18\x02 \x01(\x0b\x32(.google.cloud.talent.v4beta1.ClientEvent2\xe3\x02\n\x0c\x45ventService\x12\xe4\x01\n\x11\x43reateClientEvent\x12\x35.google.cloud.talent.v4beta1.CreateClientEventRequest\x1a(.google.cloud.talent.v4beta1.ClientEvent"n\x82\xd3\xe4\x93\x02h"3/v4beta1/{parent=projects/*/tenants/*}/clientEvents:\x01*Z.")/v4beta1/{parent=projects/*}/clientEvents:\x01*\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x7f\n\x1f\x63om.google.cloud.talent.v4beta1B\x11\x45ventServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_event__pb2.DESCRIPTOR, ], ) @@ -90,8 +92,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=163, - serialized_end=269, + serialized_start=188, + serialized_end=294, ) _CREATECLIENTEVENTREQUEST.fields_by_name[ @@ -113,14 +115,14 @@ Attributes: parent: - Required. Resource name of the tenant under which the event - is created. The format is + Required. Resource name of the tenant under which the event is + created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". client_event: - Required. Events issued when end user interacts with + Required. Events issued when end user interacts with customer's application that uses Cloud Talent Solution. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateClientEventRequest) @@ -136,9 +138,11 @@ full_name="google.cloud.talent.v4beta1.EventService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=272, - serialized_end=517, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=297, + serialized_end=652, methods=[ _descriptor.MethodDescriptor( name="CreateClientEvent", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters.proto index d29fbcfdb8c6..0f86b2df6ccd 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters.proto @@ -39,17 +39,13 @@ option objc_class_prefix = "CTS"; // // The query required to perform a search query. message JobQuery { - // Optional. - // - // The query string that matches against the job title, description, and - // location fields. + // Optional. The query string that matches against the job title, description, + // and location fields. // // The maximum number of allowed characters is 255. string query = 1; - // Optional. - // - // This filter specifies the company entities to search against. + // Optional. This filter specifies the company entities to search against. // // If a value isn't specified, jobs are searched for against all // companies. @@ -67,9 +63,7 @@ message JobQuery { // At most 20 company filters are allowed. repeated string companies = 2; - // Optional. - // - // The location filter specifies geo-regions containing the jobs to + // Optional. The location filter specifies geo-regions containing the jobs to // search against. See // [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] for more // information. @@ -85,11 +79,9 @@ message JobQuery { // At most 5 location filters are allowed. repeated LocationFilter location_filters = 3; - // Optional. - // - // The category filter specifies the categories of jobs to search against. - // See [JobCategory][google.cloud.talent.v4beta1.JobCategory] for more - // information. + // Optional. The category filter specifies the categories of jobs to search + // against. See [JobCategory][google.cloud.talent.v4beta1.JobCategory] for + // more information. // // If a value isn't specified, jobs from any category are searched against. // @@ -97,9 +89,8 @@ message JobQuery { // categories are searched against. repeated JobCategory job_categories = 4; - // Optional. - // - // Allows filtering jobs by commute time with different travel methods (for + // Optional. Allows filtering jobs by commute time with different travel + // methods (for // example, driving or public transit). // // Note: This only works when you specify a @@ -110,9 +101,7 @@ message JobQuery { // Currently we don't support sorting by commute time. CommuteFilter commute_filter = 5; - // Optional. - // - // This filter specifies the exact company + // Optional. This filter specifies the exact company // [Company.display_name][google.cloud.talent.v4beta1.Company.display_name] of // the jobs to search against. // @@ -125,18 +114,14 @@ message JobQuery { // At most 20 company display name filters are allowed. repeated string company_display_names = 6; - // Optional. - // - // This search filter is applied only to + // Optional. This search filter is applied only to // [Job.compensation_info][google.cloud.talent.v4beta1.Job.compensation_info]. // For example, if the filter is specified as "Hourly job with per-hour // compensation > $15", only jobs meeting these criteria are searched. If a // filter isn't defined, all open jobs are searched. CompensationFilter compensation_filter = 7; - // Optional. - // - // This filter specifies a structured syntax to match against the + // Optional. This filter specifies a structured syntax to match against the // [Job.custom_attributes][google.cloud.talent.v4beta1.Job.custom_attributes] // marked as `filterable`. // @@ -161,19 +146,15 @@ message JobQuery { // driving_years > 10` string custom_attribute_filter = 8; - // Optional. - // - // This flag controls the spell-check feature. If false, the + // Optional. This flag controls the spell-check feature. If false, the // service attempts to correct a misspelled query, // for example, "enginee" is corrected to "engineer". // // Defaults to false: a spell check is performed. bool disable_spell_check = 9; - // Optional. - // - // The employment type filter specifies the employment type of jobs to - // search against, such as + // Optional. The employment type filter specifies the employment type of jobs + // to search against, such as // [EmploymentType.FULL_TIME][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME]. // // If a value isn't specified, jobs in the search results includes any @@ -183,9 +164,7 @@ message JobQuery { // any of the specified employment types. repeated EmploymentType employment_types = 10; - // Optional. - // - // This filter specifies the locale of jobs to search against, + // Optional. This filter specifies the locale of jobs to search against, // for example, "en-US". // // If a value isn't specified, the search results can contain jobs in any @@ -199,15 +178,12 @@ message JobQuery { // At most 10 language code filters are allowed. repeated string language_codes = 11; - // Optional. - // - // Jobs published within a range specified by this filter are searched - // against. + // Optional. Jobs published within a range specified by this filter are + // searched against. TimestampRange publish_time_range = 12; - // Optional. - // - // This filter specifies a list of job names to be excluded during search. + // Optional. This filter specifies a list of job names to be excluded during + // search. // // At most 400 excluded job names are allowed. repeated string excluded_jobs = 13; @@ -215,17 +191,13 @@ message JobQuery { // Filters to apply when performing the search query. message ProfileQuery { - // Optional. - // - // Keywords to match any text fields of profiles. + // Optional. Keywords to match any text fields of profiles. // // For example, "software engineer in Palo Alto". string query = 1; - // Optional. - // - // The location filter specifies geo-regions containing the profiles to - // search against. + // Optional. The location filter specifies geo-regions containing the profiles + // to search against. // // If a location filter isn't specified, profiles fitting the other search // criteria are retrieved regardless of where they're located. @@ -237,9 +209,7 @@ message ProfileQuery { // For example, search for profiles with addresses in "New York City". repeated LocationFilter location_filters = 2; - // Optional. - // - // Job title filter specifies job titles of profiles to match on. + // Optional. Job title filter specifies job titles of profiles to match on. // // If a job title isn't specified, profiles with any titles are retrieved. // @@ -253,9 +223,7 @@ message ProfileQuery { // For example, search for profiles with a job title "Product Manager". repeated JobTitleFilter job_title_filters = 3; - // Optional. - // - // Employer filter specifies employers of profiles to match on. + // Optional. Employer filter specifies employers of profiles to match on. // // If an employer filter isn't specified, profiles with any employers are // retrieved. @@ -271,9 +239,7 @@ message ProfileQuery { // LLC". repeated EmployerFilter employer_filters = 4; - // Optional. - // - // Education filter specifies education of profiles to match on. + // Optional. Education filter specifies education of profiles to match on. // // If an education filter isn't specified, profiles with any education are // retrieved. @@ -288,9 +254,7 @@ message ProfileQuery { // For example, search for profiles with a master degree. repeated EducationFilter education_filters = 5; - // Optional. - // - // Skill filter specifies skill of profiles to match on. + // Optional. Skill filter specifies skill of profiles to match on. // // If a skill filter isn't specified, profiles with any skills are retrieved. // @@ -304,10 +268,8 @@ message ProfileQuery { // list. repeated SkillFilter skill_filters = 6; - // Optional. - // - // Work experience filter specifies the total working experience of profiles - // to match on. + // Optional. Work experience filter specifies the total working experience of + // profiles to match on. // // If a work experience filter isn't specified, profiles with any // professional experience are retrieved. @@ -318,38 +280,29 @@ message ProfileQuery { // For example, search for profiles with 10 years of work experience. repeated WorkExperienceFilter work_experience_filter = 7; - // Optional. - // - // Time filter specifies the create/update timestamp of the profiles to match - // on. + // Optional. Time filter specifies the create/update timestamp of the profiles + // to match on. // // For example, search for profiles created since "2018-1-1". repeated TimeFilter time_filters = 8; - // Optional. - // - // The hirable filter specifies the profile's hirable status to match on. + // Optional. The hirable filter specifies the profile's hirable status to + // match on. google.protobuf.BoolValue hirable_filter = 9; - // Optional. - // - // The application date filters specify application date ranges to match on. + // Optional. The application date filters specify application date ranges to + // match on. repeated ApplicationDateFilter application_date_filters = 10; - // Optional. - // - // The application outcome notes filters specify the notes for the outcome of - // the job application. + // Optional. The application outcome notes filters specify the notes for the + // outcome of the job application. repeated ApplicationOutcomeNotesFilter application_outcome_notes_filters = 11; - // Optional. - // - // The application job filters specify the job applied for in the application. + // Optional. The application job filters specify the job applied for in the + // application. repeated ApplicationJobFilter application_job_filters = 13; - // Optional. - // - // This filter specifies a structured syntax to match against the + // Optional. This filter specifies a structured syntax to match against the // [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes] // that are marked as `filterable`. // @@ -375,6 +328,24 @@ message ProfileQuery { // Sample Query: // (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) string custom_attribute_filter = 15; + + // Optional. The candidate availability filter which filters based on + // availability signals. + // + // Signal 1: Number of days since most recent job application. See + // [Availability.JobApplicationAvailabilitySignal][google.cloud.talent.v4beta1.Availability.JobApplicationAvailabilitySignal] + // for the details of this signal. + // + // Signal 2: Number of days since last profile update. See + // [Availability.ProfileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] + // for the details of this signal. + // + // The candidate availability filter helps a recruiter understand if a + // specific candidate is likely to be actively seeking new job opportunities + // based on an aggregated set of signals. Specifically, the intent is NOT to + // indicate the candidate's potential qualification / interest / close ability + // for a specific job. + CandidateAvailabilityFilter candidate_availability_filter = 16; } // Input only. @@ -393,16 +364,12 @@ message LocationFilter { TELECOMMUTE_ALLOWED = 2; } - // Optional. - // - // The address name, such as "Mountain View" or "Bay Area". + // Optional. The address name, such as "Mountain View" or "Bay Area". string address = 1; - // Optional. - // - // CLDR region code of the country/region of the address. This is used - // to address ambiguity of the user-input location, for example, "Liverpool" - // against "Liverpool, NY, US" or "Liverpool, UK". + // Optional. CLDR region code of the country/region of the address. This is + // used to address ambiguity of the user-input location, for example, + // "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". // // Set this field if all the jobs to search against are from a same region, // or jobs are world-wide, but the job seeker is from a specific region. @@ -410,26 +377,20 @@ message LocationFilter { // See http://cldr.unicode.org/ and // http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html // for details. Example: "CH" for Switzerland. + // Note that this filter is not applicable for Profile Search related queries. string region_code = 2; - // Optional. - // - // The latitude and longitude of the geographic center from which to + // Optional. The latitude and longitude of the geographic center from which to // search. This field's ignored if `address` is provided. google.type.LatLng lat_lng = 3; - // Optional. - // - // - // The distance_in_miles is applied when the location being searched for is - // identified as a city or smaller. When the location being searched for is a - // state or larger, this field is ignored. + // Optional. The distance_in_miles is applied when the location being searched + // for is identified as a city or smaller. When the location being searched + // for is a state or larger, this field is ignored. double distance_in_miles = 4; - // Optional. - // - // Allows the client to return jobs without a - // set location, specifically, telecommuting jobs (telecomuting is considered + // Optional. Allows the client to return jobs without a + // set location, specifically, telecommuting jobs (telecommuting is considered // by the service as a special location. // [Job.posting_region][google.cloud.talent.v4beta1.Job.posting_region] // indicates if a job permits telecommuting. If this field is set to @@ -449,10 +410,8 @@ message LocationFilter { // treated as less relevant than other jobs in the search response. TelecommutePreference telecommute_preference = 5; - // Optional. - // - // Whether to apply negation to the filter so profiles matching the filter - // are excluded. + // Optional. Whether to apply negation to the filter so profiles matching the + // filter are excluded. // // Currently only supported in profile search. bool negated = 6; @@ -508,26 +467,18 @@ message CompensationFilter { ANNUALIZED_TOTAL_AMOUNT = 4; } - // Required. - // - // Type of filter. + // Required. Type of filter. FilterType type = 1; - // Required. - // - // Specify desired `base compensation entry's` + // Required. Specify desired `base compensation entry's` // [CompensationInfo.CompensationUnit][google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit]. repeated CompensationInfo.CompensationUnit units = 2; - // Optional. - // - // Compensation range. + // Optional. Compensation range. CompensationInfo.CompensationRange range = 3; - // Optional. - // - // If set to true, jobs with unspecified compensation range fields are - // included. + // Optional. If set to true, jobs with unspecified compensation range fields + // are included. bool include_jobs_with_unspecified_compensation_range = 4; } @@ -547,44 +498,36 @@ message CommuteFilter { BUSY_HOUR = 2; } - // Required. - // - // The method of transportation for which to calculate the commute time. + // Required. The method of transportation for which to calculate the commute + // time. CommuteMethod commute_method = 1; - // Required. - // - // The latitude and longitude of the location from which to calculate the - // commute time. + // Required. The latitude and longitude of the location from which to + // calculate the commute time. google.type.LatLng start_coordinates = 2; - // Required. - // - // The maximum travel time in seconds. The maximum allowed value is `3600s` - // (one hour). Format is `123s`. + // Required. The maximum travel time in seconds. The maximum allowed value is + // `3600s` (one hour). Format is `123s`. google.protobuf.Duration travel_duration = 3; - // Optional. - // If `true`, jobs without street level addresses may also be returned. - // For city level addresses, the city center is used. For state and coarser - // level addresses, text matching is used. - // If this field is set to `false` or isn't specified, only jobs that include - // street level addresses will be returned by commute search. + // Optional. If `true`, jobs without street level addresses may also be + // returned. For city level addresses, the city center is used. For state and + // coarser level addresses, text matching is used. If this field is set to + // `false` or isn't specified, only jobs that include street level addresses + // will be returned by commute search. bool allow_imprecise_addresses = 4; // Optional. // // Traffic factor to take into account while searching by commute. oneof traffic_option { - // Optional. - // - // Specifies the traffic density to use when calculating commute time. + // Optional. Specifies the traffic density to use when calculating commute + // time. RoadTraffic road_traffic = 5; - // Optional. - // - // The departure time used to calculate traffic impact, represented as - // [google.type.TimeOfDay][google.type.TimeOfDay] in local time zone. + // Optional. The departure time used to calculate traffic impact, + // represented as [google.type.TimeOfDay][google.type.TimeOfDay] in local + // time zone. // // Currently traffic model is restricted to hour level resolution. google.type.TimeOfDay departure_time = 6; @@ -595,15 +538,12 @@ message CommuteFilter { // // Job title of the search. message JobTitleFilter { - // Required. - // - // The job title, for example, "Software engineer", or "Product manager". + // Required. The job title, for example, "Software engineer", or "Product + // manager". string job_title = 1; - // Optional. - // - // Whether to apply negation to the filter so profiles matching the filter - // are excluded. + // Optional. Whether to apply negation to the filter so profiles matching the + // filter are excluded. bool negated = 2; } @@ -611,15 +551,11 @@ message JobTitleFilter { // // Skill filter of the search. message SkillFilter { - // Required. - // - // The skill name. For example, "java", "j2ee", and so on. + // Required. The skill name. For example, "java", "j2ee", and so on. string skill = 1; - // Optional. - // - // Whether to apply negation to the filter so profiles matching the filter - // are excluded. + // Optional. Whether to apply negation to the filter so profiles matching the + // filter are excluded. bool negated = 2; } @@ -647,14 +583,10 @@ message EmployerFilter { PAST_EMPLOYMENT_RECORDS_ONLY = 3; } - // Required. - // - // The name of the employer, for example "Google", "Alphabet". + // Required. The name of the employer, for example "Google", "Alphabet". string employer = 1; - // Optional. - // - // Define set of + // Optional. Define set of // [EmploymentRecord][google.cloud.talent.v4beta1.EmploymentRecord]s to search // against. // @@ -662,10 +594,8 @@ message EmployerFilter { // [EmployerFilterMode.ALL_EMPLOYMENT_RECORDS][google.cloud.talent.v4beta1.EmployerFilter.EmployerFilterMode.ALL_EMPLOYMENT_RECORDS]. EmployerFilterMode mode = 2; - // Optional. - // - // Whether to apply negation to the filter so profiles matching the filter - // is excluded. + // Optional. Whether to apply negation to the filter so profiles matching the + // filter is excluded. bool negated = 3; } @@ -673,29 +603,22 @@ message EmployerFilter { // // Education filter of the search. message EducationFilter { - // Optional. - // - // The school name. For example "MIT", "University of California, Berkeley". + // Optional. The school name. For example "MIT", "University of California, + // Berkeley". string school = 1; - // Optional. - // - // The field of study. This is to search against value provided in + // Optional. The field of study. This is to search against value provided in // [Degree.fields_of_study][google.cloud.talent.v4beta1.Degree.fields_of_study]. // For example "Computer Science", "Mathematics". string field_of_study = 2; - // Optional. - // - // Education degree in ISCED code. Each value in degree covers a specific - // level of education, without any expansion to upper nor lower levels of - // education degree. + // Optional. Education degree in ISCED code. Each value in degree covers a + // specific level of education, without any expansion to upper nor lower + // levels of education degree. DegreeType degree_type = 3; - // Optional. - // - // Whether to apply negation to the filter so profiles matching the filter - // is excluded. + // Optional. Whether to apply negation to the filter so profiles matching the + // filter is excluded. bool negated = 6; } @@ -709,14 +632,10 @@ message EducationFilter { // and // [max_experience][google.cloud.talent.v4beta1.WorkExperienceFilter.max_experience]. message WorkExperienceFilter { - // Optional. - // - // The minimum duration of the work experience (inclusive). + // Optional. The minimum duration of the work experience (inclusive). google.protobuf.Duration min_experience = 1; - // Optional. - // - // The maximum duration of the work experience (exclusive). + // Optional. The maximum duration of the work experience (exclusive). google.protobuf.Duration max_experience = 2; } @@ -732,16 +651,12 @@ message WorkExperienceFilter { // and [end_date][google.cloud.talent.v4beta1.ApplicationDateFilter.end_date] // are missing. message ApplicationDateFilter { - // Optional. - // - // Start date. If it's missing, The API matches profiles with application date - // not after the end date. + // Optional. Start date. If it's missing, The API matches profiles with + // application date not after the end date. google.type.Date start_date = 1; - // Optional. - // - // End date. If it's missing, The API matches profiles with application date - // not before the start date. + // Optional. End date. If it's missing, The API matches profiles with + // application date not before the start date. google.type.Date end_date = 2; } @@ -749,16 +664,13 @@ message ApplicationDateFilter { // // Outcome Notes Filter. message ApplicationOutcomeNotesFilter { - // Required. - // - // User entered or selected outcome reason. The API does an exact match on the + // Required. User entered or selected outcome reason. The API does an exact + // match on the // [Application.outcome_notes][google.cloud.talent.v4beta1.Application.outcome_notes] // in profiles. string outcome_notes = 1; - // Optional. - // - // If true, The API excludes all candidates with any + // Optional. If true, The API excludes all candidates with any // [Application.outcome_notes][google.cloud.talent.v4beta1.Application.outcome_notes] // matching the outcome reason specified in the filter. bool negated = 2; @@ -768,23 +680,18 @@ message ApplicationOutcomeNotesFilter { // // Filter on the job information of Application. message ApplicationJobFilter { - // Optional. - // - // The job requisition id in the application. The API does an exact match on - // the [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] of + // Optional. The job requisition id in the application. The API does an exact + // match on the + // [Job.requisition_id][google.cloud.talent.v4beta1.Job.requisition_id] of // [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles. string job_requisition_id = 2; - // Optional. - // - // The job title in the application. The API does an exact match on the - // [Job.title][google.cloud.talent.v4beta1.Job.title] of + // Optional. The job title in the application. The API does an exact match on + // the [Job.title][google.cloud.talent.v4beta1.Job.title] of // [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles. string job_title = 3; - // Optional. - // - // If true, the API excludes all profiles with any + // Optional. If true, the API excludes all profiles with any // [Application.job][google.cloud.talent.v4beta1.Application.job] matching the // filters. bool negated = 4; @@ -806,25 +713,28 @@ message TimeFilter { UPDATE_TIME = 2; } - // Optional. - // - // Start timestamp, matching profiles with the start time. If this field - // missing, The API matches profiles with create / update timestamp before the - // end timestamp. + // Optional. Start timestamp, matching profiles with the start time. If this + // field missing, The API matches profiles with create / update timestamp + // before the end timestamp. google.protobuf.Timestamp start_time = 1; - // Optional. - // - // End timestamp, matching profiles with the end time. If this field + // Optional. End timestamp, matching profiles with the end time. If this field // missing, The API matches profiles with create / update timestamp after the // start timestamp. google.protobuf.Timestamp end_time = 2; - // Optional. - // - // Specifies which time field to filter profiles. + // Optional. Specifies which time field to filter profiles. // // Defaults to // [TimeField.CREATE_TIME][google.cloud.talent.v4beta1.TimeFilter.TimeField.CREATE_TIME]. TimeField time_field = 3; } + +// Input only +// +// Filter on availability signals. +message CandidateAvailabilityFilter { + // Optional. It is false by default. If true, API excludes all the potential + // available profiles. + bool negated = 1; +} diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters_pb2.py index e7c3f04d3192..0297e789bda5 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/filters_pb2.py @@ -44,7 +44,7 @@ "\n\037com.google.cloud.talent.v4beta1B\014FiltersProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n/google/cloud/talent_v4beta1/proto/filters.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x33google/cloud/talent_v4beta1/proto/application.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a+google/cloud/talent_v4beta1/proto/job.proto\x1a/google/cloud/talent_v4beta1/proto/profile.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x1egoogle/protobuf/wrappers.proto\x1a\x16google/type/date.proto\x1a\x18google/type/latlng.proto\x1a\x1bgoogle/type/timeofday.proto"\xe3\x04\n\x08JobQuery\x12\r\n\x05query\x18\x01 \x01(\t\x12\x11\n\tcompanies\x18\x02 \x03(\t\x12\x45\n\x10location_filters\x18\x03 \x03(\x0b\x32+.google.cloud.talent.v4beta1.LocationFilter\x12@\n\x0ejob_categories\x18\x04 \x03(\x0e\x32(.google.cloud.talent.v4beta1.JobCategory\x12\x42\n\x0e\x63ommute_filter\x18\x05 \x01(\x0b\x32*.google.cloud.talent.v4beta1.CommuteFilter\x12\x1d\n\x15\x63ompany_display_names\x18\x06 \x03(\t\x12L\n\x13\x63ompensation_filter\x18\x07 \x01(\x0b\x32/.google.cloud.talent.v4beta1.CompensationFilter\x12\x1f\n\x17\x63ustom_attribute_filter\x18\x08 \x01(\t\x12\x1b\n\x13\x64isable_spell_check\x18\t \x01(\x08\x12\x45\n\x10\x65mployment_types\x18\n \x03(\x0e\x32+.google.cloud.talent.v4beta1.EmploymentType\x12\x16\n\x0elanguage_codes\x18\x0b \x03(\t\x12G\n\x12publish_time_range\x18\x0c \x01(\x0b\x32+.google.cloud.talent.v4beta1.TimestampRange\x12\x15\n\rexcluded_jobs\x18\r \x03(\t"\xf5\x06\n\x0cProfileQuery\x12\r\n\x05query\x18\x01 \x01(\t\x12\x45\n\x10location_filters\x18\x02 \x03(\x0b\x32+.google.cloud.talent.v4beta1.LocationFilter\x12\x46\n\x11job_title_filters\x18\x03 \x03(\x0b\x32+.google.cloud.talent.v4beta1.JobTitleFilter\x12\x45\n\x10\x65mployer_filters\x18\x04 \x03(\x0b\x32+.google.cloud.talent.v4beta1.EmployerFilter\x12G\n\x11\x65\x64ucation_filters\x18\x05 \x03(\x0b\x32,.google.cloud.talent.v4beta1.EducationFilter\x12?\n\rskill_filters\x18\x06 \x03(\x0b\x32(.google.cloud.talent.v4beta1.SkillFilter\x12Q\n\x16work_experience_filter\x18\x07 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.WorkExperienceFilter\x12=\n\x0ctime_filters\x18\x08 \x03(\x0b\x32\'.google.cloud.talent.v4beta1.TimeFilter\x12\x32\n\x0ehirable_filter\x18\t \x01(\x0b\x32\x1a.google.protobuf.BoolValue\x12T\n\x18\x61pplication_date_filters\x18\n \x03(\x0b\x32\x32.google.cloud.talent.v4beta1.ApplicationDateFilter\x12\x65\n!application_outcome_notes_filters\x18\x0b \x03(\x0b\x32:.google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter\x12R\n\x17\x61pplication_job_filters\x18\r \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.ApplicationJobFilter\x12\x1f\n\x17\x63ustom_attribute_filter\x18\x0f \x01(\t"\xdf\x02\n\x0eLocationFilter\x12\x0f\n\x07\x61\x64\x64ress\x18\x01 \x01(\t\x12\x13\n\x0bregion_code\x18\x02 \x01(\t\x12$\n\x07lat_lng\x18\x03 \x01(\x0b\x32\x13.google.type.LatLng\x12\x19\n\x11\x64istance_in_miles\x18\x04 \x01(\x01\x12\x61\n\x16telecommute_preference\x18\x05 \x01(\x0e\x32\x41.google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference\x12\x0f\n\x07negated\x18\x06 \x01(\x08"r\n\x15TelecommutePreference\x12&\n"TELECOMMUTE_PREFERENCE_UNSPECIFIED\x10\x00\x12\x18\n\x14TELECOMMUTE_EXCLUDED\x10\x01\x12\x17\n\x13TELECOMMUTE_ALLOWED\x10\x02"\xc0\x03\n\x12\x43ompensationFilter\x12H\n\x04type\x18\x01 \x01(\x0e\x32:.google.cloud.talent.v4beta1.CompensationFilter.FilterType\x12M\n\x05units\x18\x02 \x03(\x0e\x32>.google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit\x12N\n\x05range\x18\x03 \x01(\x0b\x32?.google.cloud.talent.v4beta1.CompensationInfo.CompensationRange\x12\x38\n0include_jobs_with_unspecified_compensation_range\x18\x04 \x01(\x08"\x86\x01\n\nFilterType\x12\x1b\n\x17\x46ILTER_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tUNIT_ONLY\x10\x01\x12\x13\n\x0fUNIT_AND_AMOUNT\x10\x02\x12\x1a\n\x16\x41NNUALIZED_BASE_AMOUNT\x10\x03\x12\x1b\n\x17\x41NNUALIZED_TOTAL_AMOUNT\x10\x04"\xbc\x03\n\rCommuteFilter\x12\x42\n\x0e\x63ommute_method\x18\x01 \x01(\x0e\x32*.google.cloud.talent.v4beta1.CommuteMethod\x12.\n\x11start_coordinates\x18\x02 \x01(\x0b\x32\x13.google.type.LatLng\x12\x32\n\x0ftravel_duration\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12!\n\x19\x61llow_imprecise_addresses\x18\x04 \x01(\x08\x12N\n\x0croad_traffic\x18\x05 \x01(\x0e\x32\x36.google.cloud.talent.v4beta1.CommuteFilter.RoadTrafficH\x00\x12\x30\n\x0e\x64\x65parture_time\x18\x06 \x01(\x0b\x32\x16.google.type.TimeOfDayH\x00"L\n\x0bRoadTraffic\x12\x1c\n\x18ROAD_TRAFFIC_UNSPECIFIED\x10\x00\x12\x10\n\x0cTRAFFIC_FREE\x10\x01\x12\r\n\tBUSY_HOUR\x10\x02\x42\x10\n\x0etraffic_option"4\n\x0eJobTitleFilter\x12\x11\n\tjob_title\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"-\n\x0bSkillFilter\x12\r\n\x05skill\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"\xa1\x02\n\x0e\x45mployerFilter\x12\x10\n\x08\x65mployer\x18\x01 \x01(\t\x12L\n\x04mode\x18\x02 \x01(\x0e\x32>.google.cloud.talent.v4beta1.EmployerFilter.EmployerFilterMode\x12\x0f\n\x07negated\x18\x03 \x01(\x08"\x9d\x01\n\x12\x45mployerFilterMode\x12$\n EMPLOYER_FILTER_MODE_UNSPECIFIED\x10\x00\x12\x1a\n\x16\x41LL_EMPLOYMENT_RECORDS\x10\x01\x12#\n\x1f\x43URRENT_EMPLOYMENT_RECORDS_ONLY\x10\x02\x12 \n\x1cPAST_EMPLOYMENT_RECORDS_ONLY\x10\x03"\x88\x01\n\x0f\x45\x64ucationFilter\x12\x0e\n\x06school\x18\x01 \x01(\t\x12\x16\n\x0e\x66ield_of_study\x18\x02 \x01(\t\x12<\n\x0b\x64\x65gree_type\x18\x03 \x01(\x0e\x32\'.google.cloud.talent.v4beta1.DegreeType\x12\x0f\n\x07negated\x18\x06 \x01(\x08"|\n\x14WorkExperienceFilter\x12\x31\n\x0emin_experience\x18\x01 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x31\n\x0emax_experience\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration"c\n\x15\x41pplicationDateFilter\x12%\n\nstart_date\x18\x01 \x01(\x0b\x32\x11.google.type.Date\x12#\n\x08\x65nd_date\x18\x02 \x01(\x0b\x32\x11.google.type.Date"G\n\x1d\x41pplicationOutcomeNotesFilter\x12\x15\n\routcome_notes\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"V\n\x14\x41pplicationJobFilter\x12\x1a\n\x12job_requisition_id\x18\x02 \x01(\t\x12\x11\n\tjob_title\x18\x03 \x01(\t\x12\x0f\n\x07negated\x18\x04 \x01(\x08"\xfc\x01\n\nTimeFilter\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x45\n\ntime_field\x18\x03 \x01(\x0e\x32\x31.google.cloud.talent.v4beta1.TimeFilter.TimeField"I\n\tTimeField\x12\x1a\n\x16TIME_FIELD_UNSPECIFIED\x10\x00\x12\x0f\n\x0b\x43REATE_TIME\x10\x01\x12\x0f\n\x0bUPDATE_TIME\x10\x02\x42z\n\x1f\x63om.google.cloud.talent.v4beta1B\x0c\x46iltersProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n/google/cloud/talent_v4beta1/proto/filters.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x33google/cloud/talent_v4beta1/proto/application.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a+google/cloud/talent_v4beta1/proto/job.proto\x1a/google/cloud/talent_v4beta1/proto/profile.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x1egoogle/protobuf/wrappers.proto\x1a\x16google/type/date.proto\x1a\x18google/type/latlng.proto\x1a\x1bgoogle/type/timeofday.proto"\xe3\x04\n\x08JobQuery\x12\r\n\x05query\x18\x01 \x01(\t\x12\x11\n\tcompanies\x18\x02 \x03(\t\x12\x45\n\x10location_filters\x18\x03 \x03(\x0b\x32+.google.cloud.talent.v4beta1.LocationFilter\x12@\n\x0ejob_categories\x18\x04 \x03(\x0e\x32(.google.cloud.talent.v4beta1.JobCategory\x12\x42\n\x0e\x63ommute_filter\x18\x05 \x01(\x0b\x32*.google.cloud.talent.v4beta1.CommuteFilter\x12\x1d\n\x15\x63ompany_display_names\x18\x06 \x03(\t\x12L\n\x13\x63ompensation_filter\x18\x07 \x01(\x0b\x32/.google.cloud.talent.v4beta1.CompensationFilter\x12\x1f\n\x17\x63ustom_attribute_filter\x18\x08 \x01(\t\x12\x1b\n\x13\x64isable_spell_check\x18\t \x01(\x08\x12\x45\n\x10\x65mployment_types\x18\n \x03(\x0e\x32+.google.cloud.talent.v4beta1.EmploymentType\x12\x16\n\x0elanguage_codes\x18\x0b \x03(\t\x12G\n\x12publish_time_range\x18\x0c \x01(\x0b\x32+.google.cloud.talent.v4beta1.TimestampRange\x12\x15\n\rexcluded_jobs\x18\r \x03(\t"\xd6\x07\n\x0cProfileQuery\x12\r\n\x05query\x18\x01 \x01(\t\x12\x45\n\x10location_filters\x18\x02 \x03(\x0b\x32+.google.cloud.talent.v4beta1.LocationFilter\x12\x46\n\x11job_title_filters\x18\x03 \x03(\x0b\x32+.google.cloud.talent.v4beta1.JobTitleFilter\x12\x45\n\x10\x65mployer_filters\x18\x04 \x03(\x0b\x32+.google.cloud.talent.v4beta1.EmployerFilter\x12G\n\x11\x65\x64ucation_filters\x18\x05 \x03(\x0b\x32,.google.cloud.talent.v4beta1.EducationFilter\x12?\n\rskill_filters\x18\x06 \x03(\x0b\x32(.google.cloud.talent.v4beta1.SkillFilter\x12Q\n\x16work_experience_filter\x18\x07 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.WorkExperienceFilter\x12=\n\x0ctime_filters\x18\x08 \x03(\x0b\x32\'.google.cloud.talent.v4beta1.TimeFilter\x12\x32\n\x0ehirable_filter\x18\t \x01(\x0b\x32\x1a.google.protobuf.BoolValue\x12T\n\x18\x61pplication_date_filters\x18\n \x03(\x0b\x32\x32.google.cloud.talent.v4beta1.ApplicationDateFilter\x12\x65\n!application_outcome_notes_filters\x18\x0b \x03(\x0b\x32:.google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter\x12R\n\x17\x61pplication_job_filters\x18\r \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.ApplicationJobFilter\x12\x1f\n\x17\x63ustom_attribute_filter\x18\x0f \x01(\t\x12_\n\x1d\x63\x61ndidate_availability_filter\x18\x10 \x01(\x0b\x32\x38.google.cloud.talent.v4beta1.CandidateAvailabilityFilter"\xdf\x02\n\x0eLocationFilter\x12\x0f\n\x07\x61\x64\x64ress\x18\x01 \x01(\t\x12\x13\n\x0bregion_code\x18\x02 \x01(\t\x12$\n\x07lat_lng\x18\x03 \x01(\x0b\x32\x13.google.type.LatLng\x12\x19\n\x11\x64istance_in_miles\x18\x04 \x01(\x01\x12\x61\n\x16telecommute_preference\x18\x05 \x01(\x0e\x32\x41.google.cloud.talent.v4beta1.LocationFilter.TelecommutePreference\x12\x0f\n\x07negated\x18\x06 \x01(\x08"r\n\x15TelecommutePreference\x12&\n"TELECOMMUTE_PREFERENCE_UNSPECIFIED\x10\x00\x12\x18\n\x14TELECOMMUTE_EXCLUDED\x10\x01\x12\x17\n\x13TELECOMMUTE_ALLOWED\x10\x02"\xc0\x03\n\x12\x43ompensationFilter\x12H\n\x04type\x18\x01 \x01(\x0e\x32:.google.cloud.talent.v4beta1.CompensationFilter.FilterType\x12M\n\x05units\x18\x02 \x03(\x0e\x32>.google.cloud.talent.v4beta1.CompensationInfo.CompensationUnit\x12N\n\x05range\x18\x03 \x01(\x0b\x32?.google.cloud.talent.v4beta1.CompensationInfo.CompensationRange\x12\x38\n0include_jobs_with_unspecified_compensation_range\x18\x04 \x01(\x08"\x86\x01\n\nFilterType\x12\x1b\n\x17\x46ILTER_TYPE_UNSPECIFIED\x10\x00\x12\r\n\tUNIT_ONLY\x10\x01\x12\x13\n\x0fUNIT_AND_AMOUNT\x10\x02\x12\x1a\n\x16\x41NNUALIZED_BASE_AMOUNT\x10\x03\x12\x1b\n\x17\x41NNUALIZED_TOTAL_AMOUNT\x10\x04"\xbc\x03\n\rCommuteFilter\x12\x42\n\x0e\x63ommute_method\x18\x01 \x01(\x0e\x32*.google.cloud.talent.v4beta1.CommuteMethod\x12.\n\x11start_coordinates\x18\x02 \x01(\x0b\x32\x13.google.type.LatLng\x12\x32\n\x0ftravel_duration\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12!\n\x19\x61llow_imprecise_addresses\x18\x04 \x01(\x08\x12N\n\x0croad_traffic\x18\x05 \x01(\x0e\x32\x36.google.cloud.talent.v4beta1.CommuteFilter.RoadTrafficH\x00\x12\x30\n\x0e\x64\x65parture_time\x18\x06 \x01(\x0b\x32\x16.google.type.TimeOfDayH\x00"L\n\x0bRoadTraffic\x12\x1c\n\x18ROAD_TRAFFIC_UNSPECIFIED\x10\x00\x12\x10\n\x0cTRAFFIC_FREE\x10\x01\x12\r\n\tBUSY_HOUR\x10\x02\x42\x10\n\x0etraffic_option"4\n\x0eJobTitleFilter\x12\x11\n\tjob_title\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"-\n\x0bSkillFilter\x12\r\n\x05skill\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"\xa1\x02\n\x0e\x45mployerFilter\x12\x10\n\x08\x65mployer\x18\x01 \x01(\t\x12L\n\x04mode\x18\x02 \x01(\x0e\x32>.google.cloud.talent.v4beta1.EmployerFilter.EmployerFilterMode\x12\x0f\n\x07negated\x18\x03 \x01(\x08"\x9d\x01\n\x12\x45mployerFilterMode\x12$\n EMPLOYER_FILTER_MODE_UNSPECIFIED\x10\x00\x12\x1a\n\x16\x41LL_EMPLOYMENT_RECORDS\x10\x01\x12#\n\x1f\x43URRENT_EMPLOYMENT_RECORDS_ONLY\x10\x02\x12 \n\x1cPAST_EMPLOYMENT_RECORDS_ONLY\x10\x03"\x88\x01\n\x0f\x45\x64ucationFilter\x12\x0e\n\x06school\x18\x01 \x01(\t\x12\x16\n\x0e\x66ield_of_study\x18\x02 \x01(\t\x12<\n\x0b\x64\x65gree_type\x18\x03 \x01(\x0e\x32\'.google.cloud.talent.v4beta1.DegreeType\x12\x0f\n\x07negated\x18\x06 \x01(\x08"|\n\x14WorkExperienceFilter\x12\x31\n\x0emin_experience\x18\x01 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x31\n\x0emax_experience\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration"c\n\x15\x41pplicationDateFilter\x12%\n\nstart_date\x18\x01 \x01(\x0b\x32\x11.google.type.Date\x12#\n\x08\x65nd_date\x18\x02 \x01(\x0b\x32\x11.google.type.Date"G\n\x1d\x41pplicationOutcomeNotesFilter\x12\x15\n\routcome_notes\x18\x01 \x01(\t\x12\x0f\n\x07negated\x18\x02 \x01(\x08"V\n\x14\x41pplicationJobFilter\x12\x1a\n\x12job_requisition_id\x18\x02 \x01(\t\x12\x11\n\tjob_title\x18\x03 \x01(\t\x12\x0f\n\x07negated\x18\x04 \x01(\x08"\xfc\x01\n\nTimeFilter\x12.\n\nstart_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12,\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x45\n\ntime_field\x18\x03 \x01(\x0e\x32\x31.google.cloud.talent.v4beta1.TimeFilter.TimeField"I\n\tTimeField\x12\x1a\n\x16TIME_FIELD_UNSPECIFIED\x10\x00\x12\x0f\n\x0b\x43REATE_TIME\x10\x01\x12\x0f\n\x0bUPDATE_TIME\x10\x02".\n\x1b\x43\x61ndidateAvailabilityFilter\x12\x0f\n\x07negated\x18\x01 \x01(\x08\x42z\n\x1f\x63om.google.cloud.talent.v4beta1B\x0c\x46iltersProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, @@ -92,8 +92,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=2221, - serialized_end=2335, + serialized_start=2318, + serialized_end=2432, ) _sym_db.RegisterEnumDescriptor(_LOCATIONFILTER_TELECOMMUTEPREFERENCE) @@ -137,8 +137,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=2652, - serialized_end=2786, + serialized_start=2749, + serialized_end=2883, ) _sym_db.RegisterEnumDescriptor(_COMPENSATIONFILTER_FILTERTYPE) @@ -164,8 +164,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=3139, - serialized_end=3215, + serialized_start=3236, + serialized_end=3312, ) _sym_db.RegisterEnumDescriptor(_COMMUTEFILTER_ROADTRAFFIC) @@ -206,8 +206,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=3469, - serialized_end=3626, + serialized_start=3566, + serialized_end=3723, ) _sym_db.RegisterEnumDescriptor(_EMPLOYERFILTER_EMPLOYERFILTERMODE) @@ -233,8 +233,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=4335, - serialized_end=4408, + serialized_start=4432, + serialized_end=4505, ) _sym_db.RegisterEnumDescriptor(_TIMEFILTER_TIMEFIELD) @@ -735,6 +735,24 @@ serialized_options=None, file=DESCRIPTOR, ), + _descriptor.FieldDescriptor( + name="candidate_availability_filter", + full_name="google.cloud.talent.v4beta1.ProfileQuery.candidate_availability_filter", + index=13, + number=16, + type=11, + cpp_type=10, + label=1, + has_default_value=False, + default_value=None, + message_type=None, + enum_type=None, + containing_type=None, + is_extension=False, + extension_scope=None, + serialized_options=None, + file=DESCRIPTOR, + ), ], extensions=[], nested_types=[], @@ -745,7 +763,7 @@ extension_ranges=[], oneofs=[], serialized_start=1096, - serialized_end=1981, + serialized_end=2078, ) @@ -873,8 +891,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=1984, - serialized_end=2335, + serialized_start=2081, + serialized_end=2432, ) @@ -966,8 +984,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=2338, - serialized_end=2786, + serialized_start=2435, + serialized_end=2883, ) @@ -1103,8 +1121,8 @@ fields=[], ) ], - serialized_start=2789, - serialized_end=3233, + serialized_start=2886, + serialized_end=3330, ) @@ -1160,8 +1178,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3235, - serialized_end=3287, + serialized_start=3332, + serialized_end=3384, ) @@ -1217,8 +1235,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3289, - serialized_end=3334, + serialized_start=3386, + serialized_end=3431, ) @@ -1292,8 +1310,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3337, - serialized_end=3626, + serialized_start=3434, + serialized_end=3723, ) @@ -1385,8 +1403,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3629, - serialized_end=3765, + serialized_start=3726, + serialized_end=3862, ) @@ -1442,8 +1460,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3767, - serialized_end=3891, + serialized_start=3864, + serialized_end=3988, ) @@ -1499,8 +1517,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3893, - serialized_end=3992, + serialized_start=3990, + serialized_end=4089, ) @@ -1556,8 +1574,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3994, - serialized_end=4065, + serialized_start=4091, + serialized_end=4162, ) @@ -1631,8 +1649,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=4067, - serialized_end=4153, + serialized_start=4164, + serialized_end=4250, ) @@ -1706,8 +1724,47 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=4156, - serialized_end=4408, + serialized_start=4253, + serialized_end=4505, +) + + +_CANDIDATEAVAILABILITYFILTER = _descriptor.Descriptor( + name="CandidateAvailabilityFilter", + full_name="google.cloud.talent.v4beta1.CandidateAvailabilityFilter", + filename=None, + file=DESCRIPTOR, + containing_type=None, + fields=[ + _descriptor.FieldDescriptor( + name="negated", + full_name="google.cloud.talent.v4beta1.CandidateAvailabilityFilter.negated", + index=0, + number=1, + type=8, + cpp_type=7, + label=1, + has_default_value=False, + default_value=False, + message_type=None, + enum_type=None, + containing_type=None, + is_extension=False, + extension_scope=None, + serialized_options=None, + file=DESCRIPTOR, + ) + ], + extensions=[], + nested_types=[], + enum_types=[], + serialized_options=None, + is_extendable=False, + syntax="proto3", + extension_ranges=[], + oneofs=[], + serialized_start=4507, + serialized_end=4553, ) _JOBQUERY.fields_by_name["location_filters"].message_type = _LOCATIONFILTER @@ -1749,6 +1806,9 @@ _PROFILEQUERY.fields_by_name[ "application_job_filters" ].message_type = _APPLICATIONJOBFILTER +_PROFILEQUERY.fields_by_name[ + "candidate_availability_filter" +].message_type = _CANDIDATEAVAILABILITYFILTER _LOCATIONFILTER.fields_by_name[ "lat_lng" ].message_type = google_dot_type_dot_latlng__pb2._LATLNG @@ -1837,6 +1897,9 @@ ] = _APPLICATIONOUTCOMENOTESFILTER DESCRIPTOR.message_types_by_name["ApplicationJobFilter"] = _APPLICATIONJOBFILTER DESCRIPTOR.message_types_by_name["TimeFilter"] = _TIMEFILTER +DESCRIPTOR.message_types_by_name[ + "CandidateAvailabilityFilter" +] = _CANDIDATEAVAILABILITYFILTER _sym_db.RegisterFileDescriptor(DESCRIPTOR) JobQuery = _reflection.GeneratedProtocolMessageType( @@ -1852,23 +1915,23 @@ Attributes: query: - Optional. The query string that matches against the job - title, description, and location fields. The maximum number - of allowed characters is 255. + Optional. The query string that matches against the job title, + description, and location fields. The maximum number of + allowed characters is 255. companies: - Optional. This filter specifies the company entities to - search against. If a value isn't specified, jobs are searched - for against all companies. If multiple values are specified, - jobs are searched against the companies specified. The format - is "projects/{project\_id}/tenants/{tenant\_id}/companies/{com - pany\_id}", for example, "projects/api-test- + Optional. This filter specifies the company entities to search + against. If a value isn't specified, jobs are searched for + against all companies. If multiple values are specified, jobs + are searched against the companies specified. The format is " + projects/{project\_id}/tenants/{tenant\_id}/companies/{company + \_id}", for example, "projects/api-test- project/tenants/foo/companies/bar". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". At most 20 company filters are allowed. location_filters: - Optional. The location filter specifies geo-regions - containing the jobs to search against. See + Optional. The location filter specifies geo-regions containing + the jobs to search against. See [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved @@ -1880,39 +1943,39 @@ distance is used for all locations. At most 5 location filters are allowed. job_categories: - Optional. The category filter specifies the categories of - jobs to search against. See + Optional. The category filter specifies the categories of jobs + to search against. See [JobCategory][google.cloud.talent.v4beta1.JobCategory] for more information. If a value isn't specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. commute_filter: - Optional. Allows filtering jobs by commute time with - different travel methods (for example, driving or public - transit). Note: This only works when you specify a + Optional. Allows filtering jobs by commute time with different + travel methods (for example, driving or public transit). + Note: This only works when you specify a [CommuteMethod][google.cloud.talent.v4beta1.CommuteMethod]. In this case, [location\_filters][google.cloud.talent.v4beta1.Job Query.location\_filters] is ignored. Currently we don't support sorting by commute time. company_display_names: - Optional. This filter specifies the exact company [Company.di - splay\_name][google.cloud.talent.v4beta1.Company.display\_name - ] of the jobs to search against. If a value isn't specified, + Optional. This filter specifies the exact company [Company.dis + play\_name][google.cloud.talent.v4beta1.Company.display\_name] + of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. compensation_filter: - Optional. This search filter is applied only to [Job.compensa - tion\_info][google.cloud.talent.v4beta1.Job.compensation\_info - ]. For example, if the filter is specified as "Hourly job with + Optional. This search filter is applied only to [Job.compensat + ion\_info][google.cloud.talent.v4beta1.Job.compensation\_info] + . For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. custom_attribute_filter: - Optional. This filter specifies a structured syntax to match + Optional. This filter specifies a structured syntax to match against the [Job.custom\_attributes][google.cloud.talent.v4bet a1.Job.custom\_attributes] marked as ``filterable``. The syntax for this expression is a subset of SQL syntax. @@ -1930,12 +1993,12 @@ Sample Query: ``(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10`` disable_spell_check: - Optional. This flag controls the spell-check feature. If + Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. employment_types: - Optional. The employment type filter specifies the employment + Optional. The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL\_ TIME][google.cloud.talent.v4beta1.EmploymentType.FULL\_TIME]. If a value isn't specified, jobs in the search results @@ -1943,7 +2006,7 @@ specified, jobs in the search results include any of the specified employment types. language_codes: - Optional. This filter specifies the locale of jobs to search + Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr- @@ -1951,10 +2014,10 @@ Languages `__. At most 10 language code filters are allowed. publish_time_range: - Optional. Jobs published within a range specified by this + Optional. Jobs published within a range specified by this filter are searched against. excluded_jobs: - Optional. This filter specifies a list of job names to be + Optional. This filter specifies a list of job names to be excluded during search. At most 400 excluded job names are allowed. """, @@ -1974,28 +2037,28 @@ Attributes: query: - Optional. Keywords to match any text fields of profiles. For + Optional. Keywords to match any text fields of profiles. For example, "software engineer in Palo Alto". location_filters: - Optional. The location filter specifies geo-regions - containing the profiles to search against. If a location - filter isn't specified, profiles fitting the other search - criteria are retrieved regardless of where they're located. - If [LocationFilter.negated][google.cloud.talent.v4beta1.Locati - onFilter.negated] is specified, the result doesn't contain - profiles from that location. For example, search for profiles - with addresses in "New York City". + Optional. The location filter specifies geo-regions containing + the profiles to search against. If a location filter isn't + specified, profiles fitting the other search criteria are + retrieved regardless of where they're located. If [LocationFi + lter.negated][google.cloud.talent.v4beta1.LocationFilter.negat + ed] is specified, the result doesn't contain profiles from + that location. For example, search for profiles with + addresses in "New York City". job_title_filters: - Optional. Job title filter specifies job titles of profiles - to match on. If a job title isn't specified, profiles with - any titles are retrieved. If multiple values are specified, + Optional. Job title filter specifies job titles of profiles to + match on. If a job title isn't specified, profiles with any + titles are retrieved. If multiple values are specified, profiles are retrieved with any of the specified job titles. If [JobTitleFilter.negated][google.cloud.talent.v4beta1.JobTit leFilter.negated] is specified, the result won't contain profiles with the job titles. For example, search for profiles with a job title "Product Manager". employer_filters: - Optional. Employer filter specifies employers of profiles to + Optional. Employer filter specifies employers of profiles to match on. If an employer filter isn't specified, profiles with any employers are retrieved. If multiple employer filters are specified, profiles with any matching employers @@ -2005,7 +2068,7 @@ search for profiles that have working experience at "Google LLC". education_filters: - Optional. Education filter specifies education of profiles to + Optional. Education filter specifies education of profiles to match on. If an education filter isn't specified, profiles with any education are retrieved. If multiple education filters are specified, profiles that match any education @@ -2014,7 +2077,7 @@ result won't contain profiles that match the educations. For example, search for profiles with a master degree. skill_filters: - Optional. Skill filter specifies skill of profiles to match + Optional. Skill filter specifies skill of profiles to match on. If a skill filter isn't specified, profiles with any skills are retrieved. If multiple skill filters are specified, profiles that match any skill filters are @@ -2023,7 +2086,7 @@ profiles that match the skills. For example, search for profiles that have "Java" and "Python" in skill list. work_experience_filter: - Optional. Work experience filter specifies the total working + Optional. Work experience filter specifies the total working experience of profiles to match on. If a work experience filter isn't specified, profiles with any professional experience are retrieved. If multiple work experience filters @@ -2031,23 +2094,23 @@ are retrieved. For example, search for profiles with 10 years of work experience. time_filters: - Optional. Time filter specifies the create/update timestamp - of the profiles to match on. For example, search for profiles + Optional. Time filter specifies the create/update timestamp of + the profiles to match on. For example, search for profiles created since "2018-1-1". hirable_filter: - Optional. The hirable filter specifies the profile's hirable + Optional. The hirable filter specifies the profile's hirable status to match on. application_date_filters: - Optional. The application date filters specify application + Optional. The application date filters specify application date ranges to match on. application_outcome_notes_filters: - Optional. The application outcome notes filters specify the + Optional. The application outcome notes filters specify the notes for the outcome of the job application. application_job_filters: - Optional. The application job filters specify the job applied + Optional. The application job filters specify the job applied for in the application. custom_attribute_filter: - Optional. This filter specifies a structured syntax to match + Optional. This filter specifies a structured syntax to match against the [Profile.custom\_attributes][google.cloud.talent.v 4beta1.Profile.custom\_attributes] that are marked as ``filterable``. The syntax for this expression is a subset of @@ -2065,6 +2128,21 @@ a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) + candidate_availability_filter: + Optional. The candidate availability filter which filters + based on availability signals. Signal 1: Number of days since + most recent job application. See [Availability.JobApplicationA + vailabilitySignal][google.cloud.talent.v4beta1.Availability.Jo + bApplicationAvailabilitySignal] for the details of this + signal. Signal 2: Number of days since last profile update. + See [Availability.ProfileUpdateAvailabilitySignal][google.clou + d.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] + for the details of this signal. The candidate availability + filter helps a recruiter understand if a specific candidate is + likely to be actively seeking new job opportunities based on + an aggregated set of signals. Specifically, the intent is NOT + to indicate the candidate's potential qualification / interest + / close ability for a specific job. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.ProfileQuery) ), @@ -2084,10 +2162,10 @@ Attributes: address: - Optional. The address name, such as "Mountain View" or "Bay + Optional. The address name, such as "Mountain View" or "Bay Area". region_code: - Optional. CLDR region code of the country/region of the + Optional. CLDR region code of the country/region of the address. This is used to address ambiguity of the user-input location, for example, "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search @@ -2095,19 +2173,20 @@ the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/chart s/30/supplemental/territory\_information.html for details. - Example: "CH" for Switzerland. + Example: "CH" for Switzerland. Note that this filter is not + applicable for Profile Search related queries. lat_lng: - Optional. The latitude and longitude of the geographic center + Optional. The latitude and longitude of the geographic center from which to search. This field's ignored if ``address`` is provided. distance_in_miles: - Optional. The distance\_in\_miles is applied when the - location being searched for is identified as a city or - smaller. When the location being searched for is a state or - larger, this field is ignored. + Optional. The distance\_in\_miles is applied when the location + being searched for is identified as a city or smaller. When + the location being searched for is a state or larger, this + field is ignored. telecommute_preference: - Optional. Allows the client to return jobs without a set - location, specifically, telecommuting jobs (telecomuting is + Optional. Allows the client to return jobs without a set + location, specifically, telecommuting jobs (telecommuting is considered by the service as a special location. [Job.posting\ _region][google.cloud.talent.v4beta1.Job.posting\_region] indicates if a job permits telecommuting. If this field is set @@ -2127,7 +2206,7 @@ other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. negated: - Optional. Whether to apply negation to the filter so profiles + Optional. Whether to apply negation to the filter so profiles matching the filter are excluded. Currently only supported in profile search. """, @@ -2149,15 +2228,15 @@ Attributes: type: - Required. Type of filter. + Required. Type of filter. units: - Required. Specify desired ``base compensation entry's`` [Comp - ensationInfo.CompensationUnit][google.cloud.talent.v4beta1.Com - pensationInfo.CompensationUnit]. + Required. Specify desired ``base compensation entry's`` [Compe + nsationInfo.CompensationUnit][google.cloud.talent.v4beta1.Comp + ensationInfo.CompensationUnit]. range: - Optional. Compensation range. + Optional. Compensation range. include_jobs_with_unspecified_compensation_range: - Optional. If set to true, jobs with unspecified compensation + Optional. If set to true, jobs with unspecified compensation range fields are included. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CompensationFilter) @@ -2178,13 +2257,13 @@ Attributes: commute_method: - Required. The method of transportation for which to calculate + Required. The method of transportation for which to calculate the commute time. start_coordinates: - Required. The latitude and longitude of the location from + Required. The latitude and longitude of the location from which to calculate the commute time. travel_duration: - Required. The maximum travel time in seconds. The maximum + Required. The maximum travel time in seconds. The maximum allowed value is ``3600s`` (one hour). Format is ``123s``. allow_imprecise_addresses: Optional. If ``true``, jobs without street level addresses may @@ -2197,14 +2276,13 @@ Optional. Traffic factor to take into account while searching by commute. road_traffic: - Optional. Specifies the traffic density to use when + Optional. Specifies the traffic density to use when calculating commute time. departure_time: - Optional. The departure time used to calculate traffic - impact, represented as - [google.type.TimeOfDay][google.type.TimeOfDay] in local time - zone. Currently traffic model is restricted to hour level - resolution. + Optional. The departure time used to calculate traffic impact, + represented as [google.type.TimeOfDay][google.type.TimeOfDay] + in local time zone. Currently traffic model is restricted to + hour level resolution. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CommuteFilter) ), @@ -2224,10 +2302,10 @@ Attributes: job_title: - Required. The job title, for example, "Software engineer", or + Required. The job title, for example, "Software engineer", or "Product manager". negated: - Optional. Whether to apply negation to the filter so profiles + Optional. Whether to apply negation to the filter so profiles matching the filter are excluded. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.JobTitleFilter) @@ -2248,10 +2326,10 @@ Attributes: skill: - Required. The skill name. For example, "java", "j2ee", and so + Required. The skill name. For example, "java", "j2ee", and so on. negated: - Optional. Whether to apply negation to the filter so profiles + Optional. Whether to apply negation to the filter so profiles matching the filter are excluded. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.SkillFilter) @@ -2272,16 +2350,16 @@ Attributes: employer: - Required. The name of the employer, for example "Google", + Required. The name of the employer, for example "Google", "Alphabet". mode: - Optional. Define set of [EmploymentRecord][google.cloud.talen - t.v4beta1.EmploymentRecord]s to search against. Defaults to [ - EmployerFilterMode.ALL\_EMPLOYMENT\_RECORDS][google.cloud.tale - nt.v4beta1.EmployerFilter.EmployerFilterMode.ALL\_EMPLOYMENT\_ - RECORDS]. + Optional. Define set of [EmploymentRecord][google.cloud.talent + .v4beta1.EmploymentRecord]s to search against. Defaults to [E + mployerFilterMode.ALL\_EMPLOYMENT\_RECORDS][google.cloud.talen + t.v4beta1.EmployerFilter.EmployerFilterMode.ALL\_EMPLOYMENT\_R + ECORDS]. negated: - Optional. Whether to apply negation to the filter so profiles + Optional. Whether to apply negation to the filter so profiles matching the filter is excluded. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.EmployerFilter) @@ -2302,19 +2380,19 @@ Attributes: school: - Optional. The school name. For example "MIT", "University of + Optional. The school name. For example "MIT", "University of California, Berkeley". field_of_study: - Optional. The field of study. This is to search against value + Optional. The field of study. This is to search against value provided in [Degree.fields\_of\_study][google.cloud.talent.v4b eta1.Degree.fields\_of\_study]. For example "Computer Science", "Mathematics". degree_type: - Optional. Education degree in ISCED code. Each value in - degree covers a specific level of education, without any - expansion to upper nor lower levels of education degree. + Optional. Education degree in ISCED code. Each value in degree + covers a specific level of education, without any expansion to + upper nor lower levels of education degree. negated: - Optional. Whether to apply negation to the filter so profiles + Optional. Whether to apply negation to the filter so profiles matching the filter is excluded. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.EducationFilter) @@ -2341,10 +2419,10 @@ Attributes: min_experience: - Optional. The minimum duration of the work experience + Optional. The minimum duration of the work experience (inclusive). max_experience: - Optional. The maximum duration of the work experience + Optional. The maximum duration of the work experience (exclusive). """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.WorkExperienceFilter) @@ -2374,10 +2452,10 @@ Attributes: start_date: - Optional. Start date. If it's missing, The API matches + Optional. Start date. If it's missing, The API matches profiles with application date not after the end date. end_date: - Optional. End date. If it's missing, The API matches profiles + Optional. End date. If it's missing, The API matches profiles with application date not before the start date. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.ApplicationDateFilter) @@ -2398,13 +2476,13 @@ Attributes: outcome_notes: - Required. User entered or selected outcome reason. The API + Required. User entered or selected outcome reason. The API does an exact match on the [Application.outcome\_notes][google .cloud.talent.v4beta1.Application.outcome\_notes] in profiles. negated: - Optional. If true, The API excludes all candidates with any [ - Application.outcome\_notes][google.cloud.talent.v4beta1.Applic - ation.outcome\_notes] matching the outcome reason specified in + Optional. If true, The API excludes all candidates with any [A + pplication.outcome\_notes][google.cloud.talent.v4beta1.Applica + tion.outcome\_notes] matching the outcome reason specified in the filter. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.ApplicationOutcomeNotesFilter) @@ -2425,19 +2503,19 @@ Attributes: job_requisition_id: - Optional. The job requisition id in the application. The API + Optional. The job requisition id in the application. The API does an exact match on the [Job.requisition\_id][google.cloud. talent.v4beta1.Job.requisition\_id] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles. job_title: - Optional. The job title in the application. The API does an + Optional. The job title in the application. The API does an exact match on the [Job.title][google.cloud.talent.v4beta1.Job.title] of [Application.job][google.cloud.talent.v4beta1.Application.job] in profiles. negated: - Optional. If true, the API excludes all profiles with any + Optional. If true, the API excludes all profiles with any [Application.job][google.cloud.talent.v4beta1.Application.job] matching the filters. """, @@ -2459,15 +2537,15 @@ Attributes: start_time: - Optional. Start timestamp, matching profiles with the start + Optional. Start timestamp, matching profiles with the start time. If this field missing, The API matches profiles with create / update timestamp before the end timestamp. end_time: - Optional. End timestamp, matching profiles with the end time. + Optional. End timestamp, matching profiles with the end time. If this field missing, The API matches profiles with create / update timestamp after the start timestamp. time_field: - Optional. Specifies which time field to filter profiles. + Optional. Specifies which time field to filter profiles. Defaults to [TimeField.CREATE\_TIME][google.cloud.talent.v4bet a1.TimeFilter.TimeField.CREATE\_TIME]. """, @@ -2476,6 +2554,27 @@ ) _sym_db.RegisterMessage(TimeFilter) +CandidateAvailabilityFilter = _reflection.GeneratedProtocolMessageType( + "CandidateAvailabilityFilter", + (_message.Message,), + dict( + DESCRIPTOR=_CANDIDATEAVAILABILITYFILTER, + __module__="google.cloud.talent_v4beta1.proto.filters_pb2", + __doc__="""Input only + + Filter on availability signals. + + + Attributes: + negated: + Optional. It is false by default. If true, API excludes all + the potential available profiles. + """, + # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CandidateAvailabilityFilter) + ), +) +_sym_db.RegisterMessage(CandidateAvailabilityFilter) + DESCRIPTOR._options = None # @@protoc_insertion_point(module_scope) diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job.proto index 78aa03bef1ed..711a4b5be4a6 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job.proto @@ -36,18 +36,14 @@ option objc_class_prefix = "CTS"; message Job { // Application related details of a job posting. message ApplicationInfo { - // Optional. - // - // Use this field to specify email address(es) to which resumes or + // Optional. Use this field to specify email address(es) to which resumes or // applications can be sent. // // The maximum number of allowed characters for each entry is 255. repeated string emails = 1; - // Optional. - // - // Use this field to provide instructions, such as "Mail your application - // to ...", that a candidate can follow to apply for the job. + // Optional. Use this field to provide instructions, such as "Mail your + // application to ...", that a candidate can follow to apply for the job. // // This field accepts and sanitizes HTML input, and also accepts // bold, italic, ordered list, and unordered list markup tags. @@ -55,10 +51,8 @@ message Job { // The maximum number of allowed characters is 3,000. string instruction = 2; - // Optional. - // - // Use this URI field to direct an applicant to a website, for example to - // link to an online application form. + // Optional. Use this URI field to direct an applicant to a website, for + // example to link to an online application form. // // The maximum number of allowed characters for each entry is 2,000. repeated string uris = 3; @@ -87,15 +81,11 @@ message Job { // // Options for job processing. message ProcessingOptions { - // Optional. - // - // If set to `true`, the service does not attempt to resolve a + // Optional. If set to `true`, the service does not attempt to resolve a // more precise address for the job. bool disable_street_address_resolution = 1; - // Optional. - // - // Option for job HTML content sanitization. Applied fields are: + // Optional. Option for job HTML content sanitization. Applied fields are: // // * description // * applicationInfo.instruction @@ -128,9 +118,7 @@ message Job { // value is unique. string name = 1; - // Required. - // - // The resource name of the company listing the job. + // Required. The resource name of the company listing the job. // // The format is // "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for @@ -140,12 +128,10 @@ message Job { // example, "projects/api-test-project/companies/bar". string company = 2; - // Required. - // - // The requisition ID, also referred to as the posting ID, is assigned by the - // client to identify a job. This field is intended to be used by clients - // for client identification and tracking of postings. A job isn't allowed - // to be created if there is another job with the same + // Required. The requisition ID, also referred to as the posting ID, is + // assigned by the client to identify a job. This field is intended to be used + // by clients for client identification and tracking of postings. A job isn't + // allowed to be created if there is another job with the same // [company][google.cloud.talent.v4beta1.Job.name], // [language_code][google.cloud.talent.v4beta1.Job.language_code] and // [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id]. @@ -153,18 +139,14 @@ message Job { // The maximum number of allowed characters is 255. string requisition_id = 3; - // Required. - // - // The title of the job, such as "Software Engineer" + // Required. The title of the job, such as "Software Engineer" // // The maximum number of allowed characters is 500. string title = 4; - // Required. - // - // The description of the job, which typically includes a multi-paragraph - // description of the company and related information. Separate fields are - // provided on the job object for + // Required. The description of the job, which typically includes a + // multi-paragraph description of the company and related information. + // Separate fields are provided on the job object for // [responsibilities][google.cloud.talent.v4beta1.Job.responsibilities], // [qualifications][google.cloud.talent.v4beta1.Job.qualifications], and other // job characteristics. Use of these separate job fields is recommended. @@ -198,26 +180,18 @@ message Job { // The maximum number of allowed characters is 500. repeated string addresses = 6; - // Optional. - // - // Job application information. + // Optional. Job application information. ApplicationInfo application_info = 7; - // Optional. - // - // The benefits included with the job. + // Optional. The benefits included with the job. repeated JobBenefit job_benefits = 8; - // Optional. - // - // Job compensation information (a.k.a. "pay rate") i.e., the compensation - // that will paid to the employee. + // Optional. Job compensation information (a.k.a. "pay rate") i.e., the + // compensation that will paid to the employee. CompensationInfo compensation_info = 9; - // Optional. - // - // A map of fields to hold both filterable and non-filterable custom job - // attributes that are not covered by the provided structured fields. + // Optional. A map of fields to hold both filterable and non-filterable custom + // job attributes that are not covered by the provided structured fields. // // The keys of the map are strings up to 64 bytes and must match the // pattern: [a-zA-Z][a-zA-Z0-9_]*. For example, key0LikeThis or @@ -230,37 +204,28 @@ message Job { // is 50KB. map custom_attributes = 10; - // Optional. - // - // The desired education degrees for the job, such as Bachelors, Masters. + // Optional. The desired education degrees for the job, such as Bachelors, + // Masters. repeated DegreeType degree_types = 11; - // Optional. - // - // The department or functional area within the company with the open - // position. + // Optional. The department or functional area within the company with the + // open position. // // The maximum number of allowed characters is 255. string department = 12; - // Optional. - // - // The employment type(s) of a job, for example, + // Optional. The employment type(s) of a job, for example, // [full time][google.cloud.talent.v4beta1.EmploymentType.FULL_TIME] or // [part time][google.cloud.talent.v4beta1.EmploymentType.PART_TIME]. repeated EmploymentType employment_types = 13; - // Optional. - // - // A description of bonus, commission, and other compensation + // Optional. A description of bonus, commission, and other compensation // incentives associated with the job not including salary or pay. // // The maximum number of allowed characters is 10,000. string incentives = 14; - // Optional. - // - // The language of the posting. This field is distinct from + // Optional. The language of the posting. This field is distinct from // any requirements for fluency that are associated with the job. // // Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". @@ -275,14 +240,11 @@ message Job { // otherwise defaults to 'en_US'. string language_code = 15; - // Optional. - // - // The experience level associated with the job, such as "Entry Level". + // Optional. The experience level associated with the job, such as "Entry + // Level". JobLevel job_level = 16; - // Optional. - // - // A promotion value of the job, as determined by the client. + // Optional. A promotion value of the job, as determined by the client. // The value determines the sort order of the jobs returned when searching for // jobs using the featured jobs search call, with higher promotional values // being returned first and ties being resolved by relevance sort. Only the @@ -291,9 +253,7 @@ message Job { // Default value is 0, and negative values are treated as 0. int32 promotion_value = 17; - // Optional. - // - // A description of the qualifications required to perform the + // Optional. A description of the qualifications required to perform the // job. The use of this field is recommended // as an alternative to using the more general // [description][google.cloud.talent.v4beta1.Job.description] field. @@ -304,9 +264,7 @@ message Job { // The maximum number of allowed characters is 10,000. string qualifications = 18; - // Optional. - // - // A description of job responsibilities. The use of this field is + // Optional. A description of job responsibilities. The use of this field is // recommended as an alternative to using the more general // [description][google.cloud.talent.v4beta1.Job.description] field. // @@ -316,46 +274,36 @@ message Job { // The maximum number of allowed characters is 10,000. string responsibilities = 19; - // Optional. - // - // The job [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for - // example, state, country) throughout which the job is available. If this - // field is set, a - // [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in a search - // query within the job region finds this job posting if an exact location - // match isn't specified. If this field is set to + // Optional. The job + // [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for example, + // state, country) throughout which the job is available. If this field is + // set, a [LocationFilter][google.cloud.talent.v4beta1.LocationFilter] in a + // search query within the job region finds this job posting if an exact + // location match isn't specified. If this field is set to // [PostingRegion.NATION][google.cloud.talent.v4beta1.PostingRegion.NATION] or // [PostingRegion.ADMINISTRATIVE_AREA][google.cloud.talent.v4beta1.PostingRegion.ADMINISTRATIVE_AREA], // setting job [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] to // the same location level as this field is strongly recommended. PostingRegion posting_region = 20; - // Optional. - // - // The visibility of the job. + // Optional. The visibility of the job. // // Defaults to // [Visibility.ACCOUNT_ONLY][google.cloud.talent.v4beta1.Visibility.ACCOUNT_ONLY] // if not specified. Visibility visibility = 21; - // Optional. - // - // The start timestamp of the job in UTC time zone. Typically this field - // is used for contracting engagements. Invalid timestamps are ignored. + // Optional. The start timestamp of the job in UTC time zone. Typically this + // field is used for contracting engagements. Invalid timestamps are ignored. google.protobuf.Timestamp job_start_time = 22; - // Optional. - // - // The end timestamp of the job. Typically this field is used for contracting - // engagements. Invalid timestamps are ignored. + // Optional. The end timestamp of the job. Typically this field is used for + // contracting engagements. Invalid timestamps are ignored. google.protobuf.Timestamp job_end_time = 23; - // Optional. - // - // The timestamp this job posting was most recently published. The default - // value is the time the request arrives at the server. Invalid timestamps are - // ignored. + // Optional. The timestamp this job posting was most recently published. The + // default value is the time the request arrives at the server. Invalid + // timestamps are ignored. google.protobuf.Timestamp posting_publish_time = 24; // Optional but strongly recommended for the best service @@ -363,12 +311,13 @@ message Job { // // The expiration timestamp of the job. After this timestamp, the // job is marked as expired, and it no longer appears in search results. The - // expired job can't be deleted or listed by the - // [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] and - // [ListJobs][google.cloud.talent.v4beta1.JobService.ListJobs] APIs, but it - // can be retrieved with the + // expired job can't be listed by the + // [ListJobs][google.cloud.talent.v4beta1.JobService.ListJobs] API, but it can + // be retrieved with the // [GetJob][google.cloud.talent.v4beta1.JobService.GetJob] API or updated with - // the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] API. An + // the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] API or + // deleted with the + // [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] API. An // expired job can be updated and opened again by using a future expiration // timestamp. Updating an expired job fails if there is another existing open // job with same [company][google.cloud.talent.v4beta1.Job.company], @@ -376,15 +325,24 @@ message Job { // [requisition_id][google.cloud.talent.v4beta1.Job.requisition_id]. // // The expired jobs are retained in our system for 90 days. However, the - // overall expired job count cannot exceed 3 times the maximum of open jobs - // count over the past week, otherwise jobs with earlier expire time are - // cleaned first. Expired jobs are no longer accessible after they are cleaned + // overall expired job count cannot exceed 3 times the maximum number of + // open jobs over previous 7 days. If this threshold is exceeded, + // expired jobs are cleaned out in order of earliest expire time. + // Expired jobs are no longer accessible after they are cleaned // out. // // Invalid timestamps are ignored, and treated as expire time not provided. // - // Timestamp before the instant request is made is considered valid, the job - // will be treated as expired immediately. + // If the timestamp is before the instant request is made, the job + // is treated as expired immediately on creation. This kind of job can + // not be updated. And when creating a job with past timestamp, the + // [posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] + // must be set before + // [posting_expire_time][google.cloud.talent.v4beta1.Job.posting_expire_time]. + // The purpose of this feature is to allow other objects, such as + // [Application][google.cloud.talent.v4beta1.Application], to refer a job that + // didn't exist in the system prior to becoming expired. If you want to modify + // a job that was expired on creation, delete it and create a new one. // // If this value isn't provided at the time of job creation or is invalid, // the job posting expires after 30 days from the job's creation time. For @@ -413,8 +371,6 @@ message Job { // Output only. Derived details about the job posting. DerivedInfo derived_info = 29; - // Optional. - // - // Options for job processing. + // Optional. Options for job processing. ProcessingOptions processing_options = 30; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_pb2.py index 1af61b4e9122..150438702104 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_pb2.py @@ -942,18 +942,18 @@ Attributes: emails: - Optional. Use this field to specify email address(es) to - which resumes or applications can be sent. The maximum number - of allowed characters for each entry is 255. + Optional. Use this field to specify email address(es) to which + resumes or applications can be sent. The maximum number of + allowed characters for each entry is 255. instruction: - Optional. Use this field to provide instructions, such as + Optional. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. uris: - Optional. Use this URI field to direct an applicant to a + Optional. Use this URI field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters for each entry is 2,000. @@ -1001,10 +1001,10 @@ Attributes: disable_street_address_resolution: - Optional. If set to ``true``, the service does not attempt to + Optional. If set to ``true``, the service does not attempt to resolve a more precise address for the job. html_sanitization: - Optional. Option for job HTML content sanitization. Applied + Optional. Option for job HTML content sanitization. Applied fields are: - description - applicationInfo.instruction - incentives - qualifications - responsibilities HTML tags in these fields may be stripped if sanitiazation isn't disabled. @@ -1046,14 +1046,14 @@ ition\_id][google.cloud.talent.v4beta1.Job.requisition\_id] since this value is unique. company: - Required. The resource name of the company listing the job. + Required. The resource name of the company listing the job. The format is "projects/{project\_id}/tenants/{tenant\_id}/com panies/{company\_id}", for example, "projects/api-test- project/tenants/foo/companies/bar". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar". requisition_id: - Required. The requisition ID, also referred to as the posting + Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if @@ -1063,19 +1063,19 @@ sition\_id][google.cloud.talent.v4beta1.Job.requisition\_id]. The maximum number of allowed characters is 255. title: - Required. The title of the job, such as "Software Engineer" + Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. description: - Required. The description of the job, which typically - includes a multi-paragraph description of the company and - related information. Separate fields are provided on the job - object for [responsibilities][google.cloud.talent.v4beta1.Job. - responsibilities], [qualifications][google.cloud.talent.v4beta - 1.Job.qualifications], and other job characteristics. Use of - these separate job fields is recommended. This field accepts - and sanitizes HTML input, and also accepts bold, italic, - ordered list, and unordered list markup tags. The maximum - number of allowed characters is 100,000. + Required. The description of the job, which typically includes + a multi-paragraph description of the company and related + information. Separate fields are provided on the job object + for [responsibilities][google.cloud.talent.v4beta1.Job.respons + ibilities], [qualifications][google.cloud.talent.v4beta1.Job.q + ualifications], and other job characteristics. Use of these + separate job fields is recommended. This field accepts and + sanitizes HTML input, and also accepts bold, italic, ordered + list, and unordered list markup tags. The maximum number of + allowed characters is 100,000. addresses: Optional but strongly recommended for the best service experience. Location(s) where the employer is looking to hire @@ -1097,14 +1097,14 @@ job for better search experience. The maximum number of allowed characters is 500. application_info: - Optional. Job application information. + Optional. Job application information. job_benefits: - Optional. The benefits included with the job. + Optional. The benefits included with the job. compensation_info: - Optional. Job compensation information (a.k.a. "pay rate") + Optional. Job compensation information (a.k.a. "pay rate") i.e., the compensation that will paid to the employee. custom_attributes: - Optional. A map of fields to hold both filterable and non- + Optional. A map of fields to hold both filterable and non- filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: @@ -1116,24 +1116,24 @@ unfilterable ``string_values``, the maximum total size of ``string_values`` across all keys is 50KB. degree_types: - Optional. The desired education degrees for the job, such as + Optional. The desired education degrees for the job, such as Bachelors, Masters. department: - Optional. The department or functional area within the - company with the open position. The maximum number of allowed + Optional. The department or functional area within the company + with the open position. The maximum number of allowed characters is 255. employment_types: - Optional. The employment type(s) of a job, for example, [full + Optional. The employment type(s) of a job, for example, [full time][google.cloud.talent.v4beta1.EmploymentType.FULL\_TIME] or [part time][google.cloud.talent.v4beta1.EmploymentType.PART\_TIME]. incentives: - Optional. A description of bonus, commission, and other + Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. language_code: - Optional. The language of the posting. This field is distinct + Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see `Tags for Identifying @@ -1145,10 +1145,10 @@ [Job.description][google.cloud.talent.v4beta1.Job.description] is assigned, otherwise defaults to 'en\_US'. job_level: - Optional. The experience level associated with the job, such + Optional. The experience level associated with the job, such as "Entry Level". promotion_value: - Optional. A promotion value of the job, as determined by the + Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned @@ -1157,7 +1157,7 @@ FEATURED\_JOB\_SEARCH. Default value is 0, and negative values are treated as 0. qualifications: - Optional. A description of the qualifications required to + Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] @@ -1165,7 +1165,7 @@ accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. responsibilities: - Optional. A description of job responsibilities. The use of + Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general [description][google.cloud.talent.v4beta1.Job.description] @@ -1173,7 +1173,7 @@ accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. posting_region: - Optional. The job + Optional. The job [PostingRegion][google.cloud.talent.v4beta1.PostingRegion] (for example, state, country) throughout which the job is available. If this field is set, a @@ -1187,34 +1187,34 @@ [Job.addresses][google.cloud.talent.v4beta1.Job.addresses] to the same location level as this field is strongly recommended. visibility: - Optional. The visibility of the job. Defaults to [Visibility - .ACCOUNT\_ONLY][google.cloud.talent.v4beta1.Visibility.ACCOUNT - \_ONLY] if not specified. + Optional. The visibility of the job. Defaults to [Visibility. + ACCOUNT\_ONLY][google.cloud.talent.v4beta1.Visibility.ACCOUNT\ + _ONLY] if not specified. job_start_time: - Optional. The start timestamp of the job in UTC time zone. + Optional. The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. job_end_time: - Optional. The end timestamp of the job. Typically this field + Optional. The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. posting_publish_time: - Optional. The timestamp this job posting was most recently + Optional. The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. posting_expire_time: Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer - appears in search results. The expired job can't be deleted or - listed by the - [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] - and + appears in search results. The expired job can't be listed by + the [ListJobs][google.cloud.talent.v4beta1.JobService.ListJobs] - APIs, but it can be retrieved with the + API, but it can be retrieved with the [GetJob][google.cloud.talent.v4beta1.JobService.GetJob] API or updated with the [UpdateJob][google.cloud.talent.v4beta1.JobService.UpdateJob] + API or deleted with the + [DeleteJob][google.cloud.talent.v4beta1.JobService.DeleteJob] API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same @@ -1223,25 +1223,34 @@ quisition\_id][google.cloud.talent.v4beta1.Job.requisition\_id ]. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times - the maximum of open jobs count over the past week, otherwise - jobs with earlier expire time are cleaned first. Expired jobs - are no longer accessible after they are cleaned out. Invalid - timestamps are ignored, and treated as expire time not - provided. Timestamp before the instant request is made is - considered valid, the job will be treated as expired - immediately. If this value isn't provided at the time of job - creation or is invalid, the job posting expires after 30 days - from the job's creation time. For example, if the job was - created on 2017/01/01 13:00AM UTC with an unspecified - expiration date, the job expires after 2017/01/31 13:00AM UTC. - If this value isn't provided on job update, it depends on the - field masks set by [UpdateJobRequest.update\_mask][google.clou - d.talent.v4beta1.UpdateJobRequest.update\_mask]. If the field - masks include [job\_end\_time][google.cloud.talent.v4beta1.Job - .job\_end\_time], or the masks are empty meaning that every - field is updated, the job posting expires after 30 days from - the job's last update time. Otherwise the expiration date - isn't updated. + the maximum number of open jobs over previous 7 days. If this + threshold is exceeded, expired jobs are cleaned out in order + of earliest expire time. Expired jobs are no longer accessible + after they are cleaned out. Invalid timestamps are ignored, + and treated as expire time not provided. If the timestamp is + before the instant request is made, the job is treated as + expired immediately on creation. This kind of job can not be + updated. And when creating a job with past timestamp, the [pos + ting\_publish\_time][google.cloud.talent.v4beta1.Job.posting\_ + publish\_time] must be set before [posting\_expire\_time][goog + le.cloud.talent.v4beta1.Job.posting\_expire\_time]. The + purpose of this feature is to allow other objects, such as + [Application][google.cloud.talent.v4beta1.Application], to + refer a job that didn't exist in the system prior to becoming + expired. If you want to modify a job that was expired on + creation, delete it and create a new one. If this value isn't + provided at the time of job creation or is invalid, the job + posting expires after 30 days from the job's creation time. + For example, if the job was created on 2017/01/01 13:00AM UTC + with an unspecified expiration date, the job expires after + 2017/01/31 13:00AM UTC. If this value isn't provided on job + update, it depends on the field masks set by [UpdateJobRequest + .update\_mask][google.cloud.talent.v4beta1.UpdateJobRequest.up + date\_mask]. If the field masks include [job\_end\_time][googl + e.cloud.talent.v4beta1.Job.job\_end\_time], or the masks are + empty meaning that every field is updated, the job posting + expires after 30 days from the job's last update time. + Otherwise the expiration date isn't updated. posting_create_time: Output only. The timestamp when this job posting was created. posting_update_time: @@ -1252,7 +1261,7 @@ derived_info: Output only. Derived details about the job posting. processing_options: - Optional. Options for job processing. + Optional. Options for job processing. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Job) ), diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service.proto index 1fb605e40a06..1b0d8bfeb759 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/batch.proto"; import "google/cloud/talent/v4beta1/common.proto"; import "google/cloud/talent/v4beta1/filters.proto"; @@ -36,6 +37,11 @@ option objc_class_prefix = "CTS"; // A service handles job management, including job CRUD, enumeration and search. service JobService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Creates a new job. // // Typically, the job becomes searchable within 10 seconds, but it may take @@ -177,9 +183,7 @@ service JobService { // // Create job request. message CreateJobRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the job is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -188,9 +192,7 @@ message CreateJobRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The Job to be created. + // Required. The Job to be created. Job job = 2; } @@ -198,9 +200,7 @@ message CreateJobRequest { // // Get job request. message GetJobRequest { - // Required. - // - // The resource name of the job to retrieve. + // Required. The resource name of the job to retrieve. // // The format is // "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for @@ -215,9 +215,7 @@ message GetJobRequest { // // Update job request. message UpdateJobRequest { - // Required. - // - // The Job to be updated. + // Required. The Job to be updated. Job job = 1; // Optional but strongly recommended to be provided for the best service @@ -237,9 +235,7 @@ message UpdateJobRequest { // // Delete job request. message DeleteJobRequest { - // Required. - // - // The resource name of the job to be deleted. + // Required. The resource name of the job to be deleted. // // The format is // "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}", for @@ -254,9 +250,7 @@ message DeleteJobRequest { // // Batch delete jobs request. message BatchDeleteJobsRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the job is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -265,9 +259,7 @@ message BatchDeleteJobsRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The filter string specifies the jobs to be deleted. + // Required. The filter string specifies the jobs to be deleted. // // Supported operator: =, AND // @@ -285,9 +277,7 @@ message BatchDeleteJobsRequest { // // List jobs request. message ListJobsRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the job is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -296,9 +286,7 @@ message ListJobsRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The filter string specifies the jobs to be enumerated. + // Required. The filter string specifies the jobs to be enumerated. // // Supported operator: =, AND // @@ -318,14 +306,10 @@ message ListJobsRequest { // status = "EXPIRED" string filter = 2; - // Optional. - // - // The starting point of a query result. + // Optional. The starting point of a query result. string page_token = 3; - // Optional. - // - // The maximum number of jobs to be returned per page of results. + // Optional. The maximum number of jobs to be returned per page of results. // // If [job_view][google.cloud.talent.v4beta1.ListJobsRequest.job_view] is set // to @@ -336,9 +320,7 @@ message ListJobsRequest { // Default is 100 if empty or a number < 1 is specified. int32 page_size = 4; - // Optional. - // - // The desired job attributes returned for jobs in the + // Optional. The desired job attributes returned for jobs in the // search response. Defaults to // [JobView.JOB_VIEW_FULL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_FULL] // if no value is specified. @@ -447,20 +429,17 @@ message SearchJobsRequest { EXTREME = 6; } - // Required. - // - // Controls over how important the score of + // Required. Controls over how important the score of // [CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] // gets applied to job's final ranking position. // // An error is thrown if not specified. ImportanceLevel importance_level = 1; - // Required. - // - // Controls over how job documents get ranked on top of existing relevance - // score (determined by API algorithm). The product of ranking expression - // and relevance score is used to determine job's final ranking position. + // Required. Controls over how job documents get ranked on top of existing + // relevance score (determined by API algorithm). The product of ranking + // expression and relevance score is used to determine job's final ranking + // position. // // The syntax for this expression is a subset of Google SQL syntax. // @@ -517,9 +496,7 @@ message SearchJobsRequest { SIMPLE = 2; } - // Required. - // - // The resource name of the tenant to search within. + // Required. The resource name of the tenant to search within. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -528,39 +505,30 @@ message SearchJobsRequest { // example, "projects/api-test-project". string parent = 1; - // Optional. - // - // Mode of a search. + // Optional. Mode of a search. // // Defaults to // [SearchMode.JOB_SEARCH][google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode.JOB_SEARCH]. SearchMode search_mode = 2; - // Required. - // - // The meta information collected about the job searcher, used to improve the - // search quality of the service.. The identifiers, (such as `user_id`) are - // provided by users, and must be unique and consistent. + // Required. The meta information collected about the job searcher, used to + // improve the search quality of the service. The identifiers (such as + // `user_id`) are provided by users, and must be unique and consistent. RequestMetadata request_metadata = 3; - // Optional. - // - // Query used to search against jobs, such as keyword, location filters, etc. + // Optional. Query used to search against jobs, such as keyword, location + // filters, etc. JobQuery job_query = 4; - // Optional. - // - // Controls whether to broaden the search when it produces sparse results. - // Broadened queries append results to the end of the matching results - // list. + // Optional. Controls whether to broaden the search when it produces sparse + // results. Broadened queries append results to the end of the matching + // results list. // // Defaults to false. bool enable_broadening = 5; - // Optional. - // - // Controls if the search job request requires the return of a precise - // count of the first 300 results. Setting this to `true` ensures + // Optional. Controls if the search job request requires the return of a + // precise count of the first 300 results. Setting this to `true` ensures // consistency in the number of results per page. Best practice is to set this // value to true if a client allows users to jump directly to a // non-sequential search results page. @@ -570,9 +538,8 @@ message SearchJobsRequest { // Defaults to false. bool require_precise_result_size = 6; - // Optional. - // - // An expression specifies a histogram request against matching jobs. + // Optional. An expression specifies a histogram request against matching + // jobs. // // Expression syntax is an aggregation function call with histogram facets and // other options. @@ -681,18 +648,14 @@ message SearchJobsRequest { // [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])` repeated HistogramQuery histogram_queries = 7; - // Optional. - // - // The desired job attributes returned for jobs in the search response. - // Defaults to + // Optional. The desired job attributes returned for jobs in the search + // response. Defaults to // [JobView.JOB_VIEW_SMALL][google.cloud.talent.v4beta1.JobView.JOB_VIEW_SMALL] // if no value is specified. JobView job_view = 8; - // Optional. - // - // An integer that specifies the current offset (that is, starting result - // location, amongst the jobs deemed by the API as relevant) in search + // Optional. An integer that specifies the current offset (that is, starting + // result location, amongst the jobs deemed by the API as relevant) in search // results. This field is only considered if // [page_token][google.cloud.talent.v4beta1.SearchJobsRequest.page_token] is // unset. @@ -703,80 +666,76 @@ message SearchJobsRequest { // from the second page). int32 offset = 9; - // Optional. - // - // A limit on the number of jobs returned in the search results. + // Optional. A limit on the number of jobs returned in the search results. // Increasing this value above the default value of 10 can increase search // response time. The value can be between 1 and 100. int32 page_size = 10; - // Optional. - // - // The token specifying the current offset within + // Optional. The token specifying the current offset within // search results. See // [SearchJobsResponse.next_page_token][google.cloud.talent.v4beta1.SearchJobsResponse.next_page_token] // for an explanation of how to obtain the next set of query results. string page_token = 11; - // Optional. - // - // The criteria determining how search results are sorted. Default is - // "relevance desc". + // Optional. The criteria determining how search results are sorted. Default + // is + // `"relevance desc"`. // // Supported options are: // - // * "relevance desc": By relevance descending, as determined by the API + // * `"relevance desc"`: By relevance descending, as determined by the API // algorithms. Relevance thresholding of query results is only available // with this ordering. - // * "posting`_`publish`_`time desc": By + // * `"posting_publish_time desc"`: By // [Job.posting_publish_time][google.cloud.talent.v4beta1.Job.posting_publish_time] // descending. - // * "posting`_`update`_`time desc": By + // * `"posting_update_time desc"`: By // [Job.posting_update_time][google.cloud.talent.v4beta1.Job.posting_update_time] // descending. - // * "title": By [Job.title][google.cloud.talent.v4beta1.Job.title] ascending. - // * "title desc": By [Job.title][google.cloud.talent.v4beta1.Job.title] + // * `"title"`: By [Job.title][google.cloud.talent.v4beta1.Job.title] + // ascending. + // * `"title desc"`: By [Job.title][google.cloud.talent.v4beta1.Job.title] // descending. - // * "annualized`_`base`_`compensation": By job's + // * `"annualized_base_compensation"`: By job's // [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] // ascending. Jobs whose annualized base compensation is unspecified are put // at the end of search results. - // * "annualized`_`base`_`compensation desc": By job's + // * `"annualized_base_compensation desc"`: By job's // [CompensationInfo.annualized_base_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_base_compensation_range] // descending. Jobs whose annualized base compensation is unspecified are // put at the end of search results. - // * "annualized`_`total`_`compensation": By job's + // * `"annualized_total_compensation"`: By job's // [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] // ascending. Jobs whose annualized base compensation is unspecified are put // at the end of search results. - // * "annualized`_`total`_`compensation desc": By job's + // * `"annualized_total_compensation desc"`: By job's // [CompensationInfo.annualized_total_compensation_range][google.cloud.talent.v4beta1.CompensationInfo.annualized_total_compensation_range] // descending. Jobs whose annualized base compensation is unspecified are // put at the end of search results. - // * "custom`_`ranking desc": By the relevance score adjusted to the + // * `"custom_ranking desc"`: By the relevance score adjusted to the // [SearchJobsRequest.CustomRankingInfo.ranking_expression][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ranking_expression] // with weight factor assigned by // [SearchJobsRequest.CustomRankingInfo.importance_level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.importance_level] // in descending order. - // * "location`_`distance": By the distance between the location on jobs and - // locations specified in the - // [JobQuery.location_filters][google.cloud.talent.v4beta1.JobQuery.location_filters]. - // When this order is selected, the - // [JobQuery.location_filters][google.cloud.talent.v4beta1.JobQuery.location_filters] - // must not be empty. When a job has multiple locations, the location - // closest to one of the locations specified in the location filter will be - // used to calculate location distance. Distance is calculated by the - // distance between two lat/long coordinates, with a precision of 10e-4 - // degrees (11.3 meters). Jobs that don't have locations specified will be - // ranked below jobs having locations. Diversification strategy is still - // applied unless explicitly disabled in - // [SearchJobsRequest.diversification_level][google.cloud.talent.v4beta1.SearchJobsRequest.diversification_level]. + // * Location sorting: Use the special syntax to order jobs by distance:
+ // `"distance_from('Hawaii')"`: Order by distance from Hawaii.
+ // `"distance_from(19.89, 155.5)"`: Order by distance from a coordinate.
+ // `"distance_from('Hawaii'), distance_from('Puerto Rico')"`: Order by + // multiple locations. See details below.
+ // `"distance_from('Hawaii'), distance_from(19.89, 155.5)"`: Order by + // multiple locations. See details below.
+ // The string can have a maximum of 256 characters. When multiple distance + // centers are provided, a job that is close to any of the distance centers + // would have a high rank. When a job has multiple locations, the job + // location closest to one of the distance centers will be used. Jobs that + // don't have locations will be ranked at the bottom. Distance is calculated + // with a precision of 11.3 meters (37.4 feet). Diversification strategy is + // still applied unless explicitly disabled in + // [diversification_level][google.cloud.talent.v4beta1.SearchJobsRequest.diversification_level]. string order_by = 12; - // Optional. - // - // Controls whether highly similar jobs are returned next to each other in - // the search results. Jobs are identified as highly similar based on + // Optional. Controls whether highly similar jobs are returned next to each + // other in the search results. Jobs are identified as highly similar based on // their titles, job categories, and locations. Highly similar results are // clustered so that only one representative job of the cluster is // displayed to the job seeker higher up in the results, with the other jobs @@ -787,15 +746,11 @@ message SearchJobsRequest { // if no value is specified. DiversificationLevel diversification_level = 13; - // Optional. - // - // Controls over how job documents get ranked on top of existing relevance - // score (determined by API algorithm). + // Optional. Controls over how job documents get ranked on top of existing + // relevance score (determined by API algorithm). CustomRankingInfo custom_ranking_info = 14; - // Optional. - // - // Controls whether to disable exact keyword match on + // Optional. Controls whether to disable exact keyword match on // [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], @@ -923,9 +878,7 @@ message SearchJobsResponse { // Request to create a batch of jobs. message BatchCreateJobsRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the job is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -934,17 +887,13 @@ message BatchCreateJobsRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The jobs to be created. + // Required. The jobs to be created. repeated Job jobs = 2; } // Request to update a batch of jobs. message BatchUpdateJobsRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the job is created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenant/foo". @@ -953,9 +902,7 @@ message BatchUpdateJobsRequest { // example, "projects/api-test-project". string parent = 1; - // Required. - // - // The jobs to be updated. + // Required. The jobs to be updated. repeated Job jobs = 2; // Optional but strongly recommended to be provided for the best service diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service_pb2.py index 3217ad64bd2c..7121df0c4c20 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/job_service_pb2.py @@ -17,6 +17,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( batch_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_batch__pb2, ) @@ -48,10 +49,11 @@ "\n\037com.google.cloud.talent.v4beta1B\017JobServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n3google/cloud/talent_v4beta1/proto/job_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a-google/cloud/talent_v4beta1/proto/batch.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/filters.proto\x1a\x31google/cloud/talent_v4beta1/proto/histogram.proto\x1a+google/cloud/talent_v4beta1/proto/job.proto\x1a#google/longrunning/operations.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"Q\n\x10\x43reateJobRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12-\n\x03job\x18\x02 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job"\x1d\n\rGetJobRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"r\n\x10UpdateJobRequest\x12-\n\x03job\x18\x01 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask" \n\x10\x44\x65leteJobRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"8\n\x16\x42\x61tchDeleteJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t"\x90\x01\n\x0fListJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x36\n\x08job_view\x18\x05 \x01(\x0e\x32$.google.cloud.talent.v4beta1.JobView"\x9c\x01\n\x10ListJobsResponse\x12.\n\x04jobs\x18\x01 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata"\xa0\t\n\x11SearchJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12N\n\x0bsearch_mode\x18\x02 \x01(\x0e\x32\x39.google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode\x12\x46\n\x10request_metadata\x18\x03 \x01(\x0b\x32,.google.cloud.talent.v4beta1.RequestMetadata\x12\x38\n\tjob_query\x18\x04 \x01(\x0b\x32%.google.cloud.talent.v4beta1.JobQuery\x12\x19\n\x11\x65nable_broadening\x18\x05 \x01(\x08\x12#\n\x1brequire_precise_result_size\x18\x06 \x01(\x08\x12\x46\n\x11histogram_queries\x18\x07 \x03(\x0b\x32+.google.cloud.talent.v4beta1.HistogramQuery\x12\x36\n\x08job_view\x18\x08 \x01(\x0e\x32$.google.cloud.talent.v4beta1.JobView\x12\x0e\n\x06offset\x18\t \x01(\x05\x12\x11\n\tpage_size\x18\n \x01(\x05\x12\x12\n\npage_token\x18\x0b \x01(\t\x12\x10\n\x08order_by\x18\x0c \x01(\t\x12\x62\n\x15\x64iversification_level\x18\r \x01(\x0e\x32\x43.google.cloud.talent.v4beta1.SearchJobsRequest.DiversificationLevel\x12]\n\x13\x63ustom_ranking_info\x18\x0e \x01(\x0b\x32@.google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo\x12\x1d\n\x15\x64isable_keyword_match\x18\x10 \x01(\x08\x1a\x90\x02\n\x11\x43ustomRankingInfo\x12j\n\x10importance_level\x18\x01 \x01(\x0e\x32P.google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ImportanceLevel\x12\x1a\n\x12ranking_expression\x18\x02 \x01(\t"s\n\x0fImportanceLevel\x12 \n\x1cIMPORTANCE_LEVEL_UNSPECIFIED\x10\x00\x12\x08\n\x04NONE\x10\x01\x12\x07\n\x03LOW\x10\x02\x12\x08\n\x04MILD\x10\x03\x12\n\n\x06MEDIUM\x10\x04\x12\x08\n\x04HIGH\x10\x05\x12\x0b\n\x07\x45XTREME\x10\x06"R\n\nSearchMode\x12\x1b\n\x17SEARCH_MODE_UNSPECIFIED\x10\x00\x12\x0e\n\nJOB_SEARCH\x10\x01\x12\x17\n\x13\x46\x45\x41TURED_JOB_SEARCH\x10\x02"W\n\x14\x44iversificationLevel\x12%\n!DIVERSIFICATION_LEVEL_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\n\n\x06SIMPLE\x10\x02"\xd7\x06\n\x12SearchJobsResponse\x12R\n\rmatching_jobs\x18\x01 \x03(\x0b\x32;.google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob\x12R\n\x17histogram_query_results\x18\x02 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.HistogramQueryResult\x12\x17\n\x0fnext_page_token\x18\x03 \x01(\t\x12?\n\x10location_filters\x18\x04 \x03(\x0b\x32%.google.cloud.talent.v4beta1.Location\x12\x1c\n\x14\x65stimated_total_size\x18\x05 \x01(\x05\x12\x12\n\ntotal_size\x18\x06 \x01(\x05\x12?\n\x08metadata\x18\x07 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x12"\n\x1a\x62roadened_query_jobs_count\x18\x08 \x01(\x05\x12I\n\x10spell_correction\x18\t \x01(\x0b\x32/.google.cloud.talent.v4beta1.SpellingCorrection\x1a\xdc\x01\n\x0bMatchingJob\x12-\n\x03job\x18\x01 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12\x13\n\x0bjob_summary\x18\x02 \x01(\t\x12\x19\n\x11job_title_snippet\x18\x03 \x01(\t\x12\x1b\n\x13search_text_snippet\x18\x04 \x01(\t\x12Q\n\x0c\x63ommute_info\x18\x05 \x01(\x0b\x32;.google.cloud.talent.v4beta1.SearchJobsResponse.CommuteInfo\x1a~\n\x0b\x43ommuteInfo\x12;\n\x0cjob_location\x18\x01 \x01(\x0b\x32%.google.cloud.talent.v4beta1.Location\x12\x32\n\x0ftravel_duration\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration"X\n\x16\x42\x61tchCreateJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12.\n\x04jobs\x18\x02 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job"\x89\x01\n\x16\x42\x61tchUpdateJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12.\n\x04jobs\x18\x02 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12/\n\x0bupdate_mask\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.FieldMask*v\n\x07JobView\x12\x18\n\x14JOB_VIEW_UNSPECIFIED\x10\x00\x12\x14\n\x10JOB_VIEW_ID_ONLY\x10\x01\x12\x14\n\x10JOB_VIEW_MINIMAL\x10\x02\x12\x12\n\x0eJOB_VIEW_SMALL\x10\x03\x12\x11\n\rJOB_VIEW_FULL\x10\x04\x32\xa2\x10\n\nJobService\x12\xbc\x01\n\tCreateJob\x12-.google.cloud.talent.v4beta1.CreateJobRequest\x1a .google.cloud.talent.v4beta1.Job"^\x82\xd3\xe4\x93\x02X"+/v4beta1/{parent=projects/*/tenants/*}/jobs:\x01*Z&"!/v4beta1/{parent=projects/*}/jobs:\x01*\x12\xb0\x01\n\x06GetJob\x12*.google.cloud.talent.v4beta1.GetJobRequest\x1a .google.cloud.talent.v4beta1.Job"X\x82\xd3\xe4\x93\x02R\x12+/v4beta1/{name=projects/*/tenants/*/jobs/*}Z#\x12!/v4beta1/{name=projects/*/jobs/*}\x12\xc4\x01\n\tUpdateJob\x12-.google.cloud.talent.v4beta1.UpdateJobRequest\x1a .google.cloud.talent.v4beta1.Job"f\x82\xd3\xe4\x93\x02`2//v4beta1/{job.name=projects/*/tenants/*/jobs/*}:\x01*Z*2%/v4beta1/{job.name=projects/*/jobs/*}:\x01*\x12\xac\x01\n\tDeleteJob\x12-.google.cloud.talent.v4beta1.DeleteJobRequest\x1a\x16.google.protobuf.Empty"X\x82\xd3\xe4\x93\x02R*+/v4beta1/{name=projects/*/tenants/*/jobs/*}Z#*!/v4beta1/{name=projects/*/jobs/*}\x12\xc1\x01\n\x08ListJobs\x12,.google.cloud.talent.v4beta1.ListJobsRequest\x1a-.google.cloud.talent.v4beta1.ListJobsResponse"X\x82\xd3\xe4\x93\x02R\x12+/v4beta1/{parent=projects/*/tenants/*}/jobsZ#\x12!/v4beta1/{parent=projects/*}/jobs\x12\xd3\x01\n\x0f\x42\x61tchDeleteJobs\x12\x33.google.cloud.talent.v4beta1.BatchDeleteJobsRequest\x1a\x16.google.protobuf.Empty"s\x82\xd3\xe4\x93\x02m"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchDelete:\x01*Z/"-/v4beta1/{parent=projects/*}/jobs:batchDelete\x12\xdb\x01\n\nSearchJobs\x12..google.cloud.talent.v4beta1.SearchJobsRequest\x1a/.google.cloud.talent.v4beta1.SearchJobsResponse"l\x82\xd3\xe4\x93\x02\x66"2/v4beta1/{parent=projects/*/tenants/*}/jobs:search:\x01*Z-"(/v4beta1/{parent=projects/*}/jobs:search:\x01*\x12\xf3\x01\n\x12SearchJobsForAlert\x12..google.cloud.talent.v4beta1.SearchJobsRequest\x1a/.google.cloud.talent.v4beta1.SearchJobsResponse"|\x82\xd3\xe4\x93\x02v":/v4beta1/{parent=projects/*/tenants/*}/jobs:searchForAlert:\x01*Z5"0/v4beta1/{parent=projects/*}/jobs:searchForAlert:\x01*\x12\xdd\x01\n\x0f\x42\x61tchCreateJobs\x12\x33.google.cloud.talent.v4beta1.BatchCreateJobsRequest\x1a\x1d.google.longrunning.Operation"v\x82\xd3\xe4\x93\x02p"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchCreate:\x01*Z2"-/v4beta1/{parent=projects/*}/jobs:batchCreate:\x01*\x12\xdd\x01\n\x0f\x42\x61tchUpdateJobs\x12\x33.google.cloud.talent.v4beta1.BatchUpdateJobsRequest\x1a\x1d.google.longrunning.Operation"v\x82\xd3\xe4\x93\x02p"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchUpdate:\x01*Z2"-/v4beta1/{parent=projects/*}/jobs:batchUpdate:\x01*B}\n\x1f\x63om.google.cloud.talent.v4beta1B\x0fJobServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n3google/cloud/talent_v4beta1/proto/job_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a-google/cloud/talent_v4beta1/proto/batch.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/filters.proto\x1a\x31google/cloud/talent_v4beta1/proto/histogram.proto\x1a+google/cloud/talent_v4beta1/proto/job.proto\x1a#google/longrunning/operations.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"Q\n\x10\x43reateJobRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12-\n\x03job\x18\x02 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job"\x1d\n\rGetJobRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"r\n\x10UpdateJobRequest\x12-\n\x03job\x18\x01 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask" \n\x10\x44\x65leteJobRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"8\n\x16\x42\x61tchDeleteJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t"\x90\x01\n\x0fListJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x02 \x01(\t\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x36\n\x08job_view\x18\x05 \x01(\x0e\x32$.google.cloud.talent.v4beta1.JobView"\x9c\x01\n\x10ListJobsResponse\x12.\n\x04jobs\x18\x01 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata"\xa0\t\n\x11SearchJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12N\n\x0bsearch_mode\x18\x02 \x01(\x0e\x32\x39.google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode\x12\x46\n\x10request_metadata\x18\x03 \x01(\x0b\x32,.google.cloud.talent.v4beta1.RequestMetadata\x12\x38\n\tjob_query\x18\x04 \x01(\x0b\x32%.google.cloud.talent.v4beta1.JobQuery\x12\x19\n\x11\x65nable_broadening\x18\x05 \x01(\x08\x12#\n\x1brequire_precise_result_size\x18\x06 \x01(\x08\x12\x46\n\x11histogram_queries\x18\x07 \x03(\x0b\x32+.google.cloud.talent.v4beta1.HistogramQuery\x12\x36\n\x08job_view\x18\x08 \x01(\x0e\x32$.google.cloud.talent.v4beta1.JobView\x12\x0e\n\x06offset\x18\t \x01(\x05\x12\x11\n\tpage_size\x18\n \x01(\x05\x12\x12\n\npage_token\x18\x0b \x01(\t\x12\x10\n\x08order_by\x18\x0c \x01(\t\x12\x62\n\x15\x64iversification_level\x18\r \x01(\x0e\x32\x43.google.cloud.talent.v4beta1.SearchJobsRequest.DiversificationLevel\x12]\n\x13\x63ustom_ranking_info\x18\x0e \x01(\x0b\x32@.google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo\x12\x1d\n\x15\x64isable_keyword_match\x18\x10 \x01(\x08\x1a\x90\x02\n\x11\x43ustomRankingInfo\x12j\n\x10importance_level\x18\x01 \x01(\x0e\x32P.google.cloud.talent.v4beta1.SearchJobsRequest.CustomRankingInfo.ImportanceLevel\x12\x1a\n\x12ranking_expression\x18\x02 \x01(\t"s\n\x0fImportanceLevel\x12 \n\x1cIMPORTANCE_LEVEL_UNSPECIFIED\x10\x00\x12\x08\n\x04NONE\x10\x01\x12\x07\n\x03LOW\x10\x02\x12\x08\n\x04MILD\x10\x03\x12\n\n\x06MEDIUM\x10\x04\x12\x08\n\x04HIGH\x10\x05\x12\x0b\n\x07\x45XTREME\x10\x06"R\n\nSearchMode\x12\x1b\n\x17SEARCH_MODE_UNSPECIFIED\x10\x00\x12\x0e\n\nJOB_SEARCH\x10\x01\x12\x17\n\x13\x46\x45\x41TURED_JOB_SEARCH\x10\x02"W\n\x14\x44iversificationLevel\x12%\n!DIVERSIFICATION_LEVEL_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x44ISABLED\x10\x01\x12\n\n\x06SIMPLE\x10\x02"\xd7\x06\n\x12SearchJobsResponse\x12R\n\rmatching_jobs\x18\x01 \x03(\x0b\x32;.google.cloud.talent.v4beta1.SearchJobsResponse.MatchingJob\x12R\n\x17histogram_query_results\x18\x02 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.HistogramQueryResult\x12\x17\n\x0fnext_page_token\x18\x03 \x01(\t\x12?\n\x10location_filters\x18\x04 \x03(\x0b\x32%.google.cloud.talent.v4beta1.Location\x12\x1c\n\x14\x65stimated_total_size\x18\x05 \x01(\x05\x12\x12\n\ntotal_size\x18\x06 \x01(\x05\x12?\n\x08metadata\x18\x07 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x12"\n\x1a\x62roadened_query_jobs_count\x18\x08 \x01(\x05\x12I\n\x10spell_correction\x18\t \x01(\x0b\x32/.google.cloud.talent.v4beta1.SpellingCorrection\x1a\xdc\x01\n\x0bMatchingJob\x12-\n\x03job\x18\x01 \x01(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12\x13\n\x0bjob_summary\x18\x02 \x01(\t\x12\x19\n\x11job_title_snippet\x18\x03 \x01(\t\x12\x1b\n\x13search_text_snippet\x18\x04 \x01(\t\x12Q\n\x0c\x63ommute_info\x18\x05 \x01(\x0b\x32;.google.cloud.talent.v4beta1.SearchJobsResponse.CommuteInfo\x1a~\n\x0b\x43ommuteInfo\x12;\n\x0cjob_location\x18\x01 \x01(\x0b\x32%.google.cloud.talent.v4beta1.Location\x12\x32\n\x0ftravel_duration\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration"X\n\x16\x42\x61tchCreateJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12.\n\x04jobs\x18\x02 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job"\x89\x01\n\x16\x42\x61tchUpdateJobsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12.\n\x04jobs\x18\x02 \x03(\x0b\x32 .google.cloud.talent.v4beta1.Job\x12/\n\x0bupdate_mask\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.FieldMask*v\n\x07JobView\x12\x18\n\x14JOB_VIEW_UNSPECIFIED\x10\x00\x12\x14\n\x10JOB_VIEW_ID_ONLY\x10\x01\x12\x14\n\x10JOB_VIEW_MINIMAL\x10\x02\x12\x12\n\x0eJOB_VIEW_SMALL\x10\x03\x12\x11\n\rJOB_VIEW_FULL\x10\x04\x32\x90\x11\n\nJobService\x12\xbc\x01\n\tCreateJob\x12-.google.cloud.talent.v4beta1.CreateJobRequest\x1a .google.cloud.talent.v4beta1.Job"^\x82\xd3\xe4\x93\x02X"+/v4beta1/{parent=projects/*/tenants/*}/jobs:\x01*Z&"!/v4beta1/{parent=projects/*}/jobs:\x01*\x12\xb0\x01\n\x06GetJob\x12*.google.cloud.talent.v4beta1.GetJobRequest\x1a .google.cloud.talent.v4beta1.Job"X\x82\xd3\xe4\x93\x02R\x12+/v4beta1/{name=projects/*/tenants/*/jobs/*}Z#\x12!/v4beta1/{name=projects/*/jobs/*}\x12\xc4\x01\n\tUpdateJob\x12-.google.cloud.talent.v4beta1.UpdateJobRequest\x1a .google.cloud.talent.v4beta1.Job"f\x82\xd3\xe4\x93\x02`2//v4beta1/{job.name=projects/*/tenants/*/jobs/*}:\x01*Z*2%/v4beta1/{job.name=projects/*/jobs/*}:\x01*\x12\xac\x01\n\tDeleteJob\x12-.google.cloud.talent.v4beta1.DeleteJobRequest\x1a\x16.google.protobuf.Empty"X\x82\xd3\xe4\x93\x02R*+/v4beta1/{name=projects/*/tenants/*/jobs/*}Z#*!/v4beta1/{name=projects/*/jobs/*}\x12\xc1\x01\n\x08ListJobs\x12,.google.cloud.talent.v4beta1.ListJobsRequest\x1a-.google.cloud.talent.v4beta1.ListJobsResponse"X\x82\xd3\xe4\x93\x02R\x12+/v4beta1/{parent=projects/*/tenants/*}/jobsZ#\x12!/v4beta1/{parent=projects/*}/jobs\x12\xd3\x01\n\x0f\x42\x61tchDeleteJobs\x12\x33.google.cloud.talent.v4beta1.BatchDeleteJobsRequest\x1a\x16.google.protobuf.Empty"s\x82\xd3\xe4\x93\x02m"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchDelete:\x01*Z/"-/v4beta1/{parent=projects/*}/jobs:batchDelete\x12\xdb\x01\n\nSearchJobs\x12..google.cloud.talent.v4beta1.SearchJobsRequest\x1a/.google.cloud.talent.v4beta1.SearchJobsResponse"l\x82\xd3\xe4\x93\x02\x66"2/v4beta1/{parent=projects/*/tenants/*}/jobs:search:\x01*Z-"(/v4beta1/{parent=projects/*}/jobs:search:\x01*\x12\xf3\x01\n\x12SearchJobsForAlert\x12..google.cloud.talent.v4beta1.SearchJobsRequest\x1a/.google.cloud.talent.v4beta1.SearchJobsResponse"|\x82\xd3\xe4\x93\x02v":/v4beta1/{parent=projects/*/tenants/*}/jobs:searchForAlert:\x01*Z5"0/v4beta1/{parent=projects/*}/jobs:searchForAlert:\x01*\x12\xdd\x01\n\x0f\x42\x61tchCreateJobs\x12\x33.google.cloud.talent.v4beta1.BatchCreateJobsRequest\x1a\x1d.google.longrunning.Operation"v\x82\xd3\xe4\x93\x02p"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchCreate:\x01*Z2"-/v4beta1/{parent=projects/*}/jobs:batchCreate:\x01*\x12\xdd\x01\n\x0f\x42\x61tchUpdateJobs\x12\x33.google.cloud.talent.v4beta1.BatchUpdateJobsRequest\x1a\x1d.google.longrunning.Operation"v\x82\xd3\xe4\x93\x02p"7/v4beta1/{parent=projects/*/tenants/*}/jobs:batchUpdate:\x01*Z2"-/v4beta1/{parent=projects/*}/jobs:batchUpdate:\x01*\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB}\n\x1f\x63om.google.cloud.talent.v4beta1B\x0fJobServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_batch__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_filters__pb2.DESCRIPTOR, @@ -100,8 +102,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=3389, - serialized_end=3507, + serialized_start=3414, + serialized_end=3532, ) _sym_db.RegisterEnumDescriptor(_JOBVIEW) @@ -147,8 +149,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=2011, - serialized_end=2126, + serialized_start=2036, + serialized_end=2151, ) _sym_db.RegisterEnumDescriptor(_SEARCHJOBSREQUEST_CUSTOMRANKINGINFO_IMPORTANCELEVEL) @@ -178,8 +180,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=2128, - serialized_end=2210, + serialized_start=2153, + serialized_end=2235, ) _sym_db.RegisterEnumDescriptor(_SEARCHJOBSREQUEST_SEARCHMODE) @@ -205,8 +207,8 @@ ], containing_type=None, serialized_options=None, - serialized_start=2212, - serialized_end=2299, + serialized_start=2237, + serialized_end=2324, ) _sym_db.RegisterEnumDescriptor(_SEARCHJOBSREQUEST_DIVERSIFICATIONLEVEL) @@ -263,8 +265,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=486, - serialized_end=567, + serialized_start=511, + serialized_end=592, ) @@ -302,8 +304,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=569, - serialized_end=598, + serialized_start=594, + serialized_end=623, ) @@ -359,8 +361,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=600, - serialized_end=714, + serialized_start=625, + serialized_end=739, ) @@ -398,8 +400,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=716, - serialized_end=748, + serialized_start=741, + serialized_end=773, ) @@ -455,8 +457,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=750, - serialized_end=806, + serialized_start=775, + serialized_end=831, ) @@ -566,8 +568,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=809, - serialized_end=953, + serialized_start=834, + serialized_end=978, ) @@ -641,8 +643,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=956, - serialized_end=1112, + serialized_start=981, + serialized_end=1137, ) @@ -698,8 +700,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=1854, - serialized_end=2126, + serialized_start=1879, + serialized_end=2151, ) _SEARCHJOBSREQUEST = _descriptor.Descriptor( @@ -988,8 +990,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=1115, - serialized_end=2299, + serialized_start=1140, + serialized_end=2324, ) @@ -1099,8 +1101,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=2809, - serialized_end=3029, + serialized_start=2834, + serialized_end=3054, ) _SEARCHJOBSRESPONSE_COMMUTEINFO = _descriptor.Descriptor( @@ -1155,8 +1157,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3031, - serialized_end=3157, + serialized_start=3056, + serialized_end=3182, ) _SEARCHJOBSRESPONSE = _descriptor.Descriptor( @@ -1337,8 +1339,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=2302, - serialized_end=3157, + serialized_start=2327, + serialized_end=3182, ) @@ -1394,8 +1396,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3159, - serialized_end=3247, + serialized_start=3184, + serialized_end=3272, ) @@ -1469,8 +1471,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=3250, - serialized_end=3387, + serialized_start=3275, + serialized_end=3412, ) _CREATEJOBREQUEST.fields_by_name[ @@ -1600,14 +1602,14 @@ Attributes: parent: - Required. The resource name of the tenant under which the job + Required. The resource name of the tenant under which the job is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". job: - Required. The Job to be created. + Required. The Job to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateJobRequest) ), @@ -1627,7 +1629,7 @@ Attributes: name: - Required. The resource name of the job to retrieve. The + Required. The resource name of the job to retrieve. The format is "projects/{project\_id}/tenants/{tenant\_id}/jobs/{job\_id}", for example, "projects/api-test- @@ -1653,7 +1655,7 @@ Attributes: job: - Required. The Job to be updated. + Required. The Job to be updated. update_mask: Optional but strongly recommended to be provided for the best service experience. If [update\_mask][google.cloud.talent.v4b @@ -1682,7 +1684,7 @@ Attributes: name: - Required. The resource name of the job to be deleted. The + Required. The resource name of the job to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/jobs/{job\_id}", for example, "projects/api-test- @@ -1708,14 +1710,14 @@ Attributes: parent: - Required. The resource name of the tenant under which the job + Required. The resource name of the tenant under which the job is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". filter: - Required. The filter string specifies the jobs to be deleted. + Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: - ``companyName`` (Required) - ``requisitionId`` (Required) Sample Query: companyName = "projects/api-test- @@ -1739,14 +1741,14 @@ Attributes: parent: - Required. The resource name of the tenant under which the job + Required. The resource name of the tenant under which the job is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". filter: - Required. The filter string specifies the jobs to be + Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: - ``companyName`` (Required) - ``requisitionId`` (Optional) - ``status`` (Optional) @@ -1758,9 +1760,9 @@ "req-1" - companyName = "projects/api-test- project/tenants/foo/companies/bar" AND status = "EXPIRED" page_token: - Optional. The starting point of a query result. + Optional. The starting point of a query result. page_size: - Optional. The maximum number of jobs to be returned per page + Optional. The maximum number of jobs to be returned per page of results. If [job\_view][google.cloud.talent.v4beta1.ListJo bsRequest.job\_view] is set to [JobView.JOB\_VIEW\_ID\_ONLY][g oogle.cloud.talent.v4beta1.JobView.JOB\_VIEW\_ID\_ONLY], the @@ -1768,7 +1770,7 @@ allowed page size is 100. Default is 100 if empty or a number < 1 is specified. job_view: - Optional. The desired job attributes returned for jobs in the + Optional. The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB\_VIEW\_FULL][google. cloud.talent.v4beta1.JobView.JOB\_VIEW\_FULL] if no value is specified. @@ -1822,14 +1824,14 @@ Attributes: importance_level: - Required. Controls over how important the score of [CustomRan - kingInfo.ranking\_expression][google.cloud.talent.v4beta1.Sear - chJobsRequest.CustomRankingInfo.ranking\_expression] gets + Required. Controls over how important the score of [CustomRank + ingInfo.ranking\_expression][google.cloud.talent.v4beta1.Searc + hJobsRequest.CustomRankingInfo.ranking\_expression] gets applied to job's final ranking position. An error is thrown if not specified. ranking_expression: - Required. Controls over how job documents get ranked on top - of existing relevance score (determined by API algorithm). The + Required. Controls over how job documents get ranked on top of + existing relevance score (determined by API algorithm). The product of ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported @@ -1854,29 +1856,29 @@ Attributes: parent: - Required. The resource name of the tenant to search within. + Required. The resource name of the tenant to search within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". search_mode: - Optional. Mode of a search. Defaults to [SearchMode.JOB\_SEA - RCH][google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode. - JOB\_SEARCH]. + Optional. Mode of a search. Defaults to [SearchMode.JOB\_SEAR + CH][google.cloud.talent.v4beta1.SearchJobsRequest.SearchMode.J + OB\_SEARCH]. request_metadata: - Required. The meta information collected about the job - searcher, used to improve the search quality of the service.. - The identifiers, (such as ``user_id``) are provided by users, + Required. The meta information collected about the job + searcher, used to improve the search quality of the service. + The identifiers (such as ``user_id``) are provided by users, and must be unique and consistent. job_query: - Optional. Query used to search against jobs, such as keyword, + Optional. Query used to search against jobs, such as keyword, location filters, etc. enable_broadening: - Optional. Controls whether to broaden the search when it + Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. require_precise_result_size: - Optional. Controls if the search job request requires the + Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to ``true`` ensures consistency in the number of results per page. Best practice is to set this value to true if a @@ -1884,7 +1886,7 @@ search results page. Enabling this flag may adversely impact performance. Defaults to false. histogram_queries: - Optional. An expression specifies a histogram request against + Optional. An expression specifies a histogram request against matching jobs. Expression syntax is an aggregation function call with histogram facets and other options. Available aggregation function calls are: \* @@ -1972,12 +1974,12 @@ numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative"])`` job_view: - Optional. The desired job attributes returned for jobs in the + Optional. The desired job attributes returned for jobs in the search response. Defaults to [JobView.JOB\_VIEW\_SMALL][google .cloud.talent.v4beta1.JobView.JOB\_VIEW\_SMALL] if no value is specified. offset: - Optional. An integer that specifies the current offset (that + Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if [page\_token][google.cloud.talent.v4beta1.Search @@ -1987,76 +1989,77 @@ pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). page_size: - Optional. A limit on the number of jobs returned in the - search results. Increasing this value above the default value - of 10 can increase search response time. The value can be - between 1 and 100. + Optional. A limit on the number of jobs returned in the search + results. Increasing this value above the default value of 10 + can increase search response time. The value can be between 1 + and 100. page_token: - Optional. The token specifying the current offset within + Optional. The token specifying the current offset within search results. See [SearchJobsResponse.next\_page\_token][goo gle.cloud.talent.v4beta1.SearchJobsResponse.next\_page\_token] for an explanation of how to obtain the next set of query results. order_by: - Optional. The criteria determining how search results are - sorted. Default is "relevance desc". Supported options are: - - "relevance desc": By relevance descending, as determined by - the API algorithms. Relevance thresholding of query results - is only available with this ordering. - "posting``_``\ - publish\ ``_``\ time desc": By [Job.posting\_publish\_time] - [google.cloud.talent.v4beta1.Job.posting\_publish\_time] - descending. - "posting``_``\ update\ ``_``\ time desc": By - [Job.posting\_update\_time][google.cloud.talent.v4beta1.Job.po - sting\_update\_time] descending. - "title": By + Optional. The criteria determining how search results are + sorted. Default is ``"relevance desc"``. Supported options + are: - ``"relevance desc"``: By relevance descending, as + determined by the API algorithms. Relevance thresholding of + query results is only available with this ordering. - + ``"posting_publish_time desc"``: By [Job.posting\_publish\_ + time][google.cloud.talent.v4beta1.Job.posting\_publish\_time] + descending. - ``"posting_update_time desc"``: By [Job.post + ing\_update\_time][google.cloud.talent.v4beta1.Job.posting\_up + date\_time] descending. - ``"title"``: By [Job.title][google.cloud.talent.v4beta1.Job.title] - ascending. - "title desc": By - [Job.title][google.cloud.talent.v4beta1.Job.title] - descending. - "annualized``_``\ base\ ``_``\ compensation": - By job's [CompensationInfo.annualized\_base\_compensation\_ - range][google.cloud.talent.v4beta1.CompensationInfo.annualized - \_base\_compensation\_range] ascending. Jobs whose - annualized base compensation is unspecified are put at the - end of search results. - "annualized``_``\ base\ ``_``\ - compensation desc": By job's [CompensationInfo.annualized\_ - base\_compensation\_range][google.cloud.talent.v4beta1.Compens - ationInfo.annualized\_base\_compensation\_range] - descending. Jobs whose annualized base compensation is - unspecified are put at the end of search results. - - "annualized``_``\ total\ ``_``\ compensation": By job's [Co - mpensationInfo.annualized\_total\_compensation\_range][google. - cloud.talent.v4beta1.CompensationInfo.annualized\_total\_compe - nsation\_range] ascending. Jobs whose annualized base - compensation is unspecified are put at the end of search - results. - "annualized``_``\ total\ ``_``\ compensation - desc": By job's [CompensationInfo.annualized\_total\_compen - sation\_range][google.cloud.talent.v4beta1.CompensationInfo.an - nualized\_total\_compensation\_range] descending. Jobs - whose annualized base compensation is unspecified are put - at the end of search results. - "custom``_``\ ranking desc": - By the relevance score adjusted to the [SearchJobsRequest.C - ustomRankingInfo.ranking\_expression][google.cloud.talent.v4be - ta1.SearchJobsRequest.CustomRankingInfo.ranking\_expression] - with weight factor assigned by [SearchJobsRequest.CustomRan - kingInfo.importance\_level][google.cloud.talent.v4beta1.Search - JobsRequest.CustomRankingInfo.importance\_level] in - descending order. - "location``_``\ distance": By the - distance between the location on jobs and locations - specified in the [JobQuery.location\_filters][google.cloud. - talent.v4beta1.JobQuery.location\_filters]. When this order - is selected, the [JobQuery.location\_filters][google.cloud. - talent.v4beta1.JobQuery.location\_filters] must not be - empty. When a job has multiple locations, the location - closest to one of the locations specified in the location - filter will be used to calculate location distance. - Distance is calculated by the distance between two lat/long - coordinates, with a precision of 10e-4 degrees (11.3 - meters). Jobs that don't have locations specified will be - ranked below jobs having locations. Diversification strategy - is still applied unless explicitly disabled in [SearchJo - bsRequest.diversification\_level][google.cloud.talent.v4beta1. - SearchJobsRequest.diversification\_level]. + ascending. - ``"title desc"``: By + [Job.title][google.cloud.talent.v4beta1.Job.title] descending. + - ``"annualized_base_compensation"``: By job's [Compensati + onInfo.annualized\_base\_compensation\_range][google.cloud.tal + ent.v4beta1.CompensationInfo.annualized\_base\_compensation\_r + ange] ascending. Jobs whose annualized base compensation is + unspecified are put at the end of search results. - + ``"annualized_base_compensation desc"``: By job's [Compensa + tionInfo.annualized\_base\_compensation\_range][google.cloud.t + alent.v4beta1.CompensationInfo.annualized\_base\_compensation\ + _range] descending. Jobs whose annualized base compensation + is unspecified are put at the end of search results. - + ``"annualized_total_compensation"``: By job's [Compensation + Info.annualized\_total\_compensation\_range][google.cloud.tale + nt.v4beta1.CompensationInfo.annualized\_total\_compensation\_r + ange] ascending. Jobs whose annualized base compensation is + unspecified are put at the end of search results. - + ``"annualized_total_compensation desc"``: By job's [Compens + ationInfo.annualized\_total\_compensation\_range][google.cloud + .talent.v4beta1.CompensationInfo.annualized\_total\_compensati + on\_range] descending. Jobs whose annualized base + compensation is unspecified are put at the end of search + results. - ``"custom_ranking desc"``: By the relevance score + adjusted to the [SearchJobsRequest.CustomRankingInfo.rankin + g\_expression][google.cloud.talent.v4beta1.SearchJobsRequest.C + ustomRankingInfo.ranking\_expression] with weight factor + assigned by [SearchJobsRequest.CustomRankingInfo.importance + \_level][google.cloud.talent.v4beta1.SearchJobsRequest.CustomR + ankingInfo.importance\_level] in descending order. - + Location sorting: Use the special syntax to order jobs by + distance: ``"distance_from('Hawaii')"``: Order by distance + from Hawaii. ``"distance_from(19.89, 155.5)"``: Order by + distance from a coordinate. ``"distance_from('Hawaii'), + distance_from('Puerto Rico')"``: Order by multiple + locations. See details below. ``"distance_from('Hawaii'), + distance_from(19.89, 155.5)"``: Order by multiple + locations. See details below. The string can have a maximum + of 256 characters. When multiple distance centers are + provided, a job that is close to any of the distance + centers would have a high rank. When a job has multiple + locations, the job location closest to one of the distance + centers will be used. Jobs that don't have locations will + be ranked at the bottom. Distance is calculated with a + precision of 11.3 meters (37.4 feet). Diversification + strategy is still applied unless explicitly disabled in + [diversification\_level][google.cloud.talent.v4beta1.SearchJob + sRequest.diversification\_level]. diversification_level: - Optional. Controls whether highly similar jobs are returned + Optional. Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only @@ -2066,10 +2069,10 @@ tionLevel.SIMPLE][google.cloud.talent.v4beta1.SearchJobsReques t.DiversificationLevel.SIMPLE] if no value is specified. custom_ranking_info: - Optional. Controls over how job documents get ranked on top - of existing relevance score (determined by API algorithm). + Optional. Controls over how job documents get ranked on top of + existing relevance score (determined by API algorithm). disable_keyword_match: - Optional. Controls whether to disable exact keyword match on + Optional. Controls whether to disable exact keyword match on [Job.title][google.cloud.talent.v4beta1.Job.title], [Job.descr iption][google.cloud.talent.v4beta1.Job.description], [Job.com pany\_display\_name][google.cloud.talent.v4beta1.Job.company\_ @@ -2235,14 +2238,14 @@ Attributes: parent: - Required. The resource name of the tenant under which the job + Required. The resource name of the tenant under which the job is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and a default tenant is created if unspecified, for example, "projects/api-test-project". jobs: - Required. The jobs to be created. + Required. The jobs to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.BatchCreateJobsRequest) ), @@ -2260,14 +2263,14 @@ Attributes: parent: - Required. The resource name of the tenant under which the job + Required. The resource name of the tenant under which the job is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenant/foo". Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project". jobs: - Required. The jobs to be updated. + Required. The jobs to be updated. update_mask: Optional but strongly recommended to be provided for the best service experience, also increase latency when checking status @@ -2297,9 +2300,11 @@ full_name="google.cloud.talent.v4beta1.JobService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=3510, - serialized_end=5592, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=3535, + serialized_end=5727, methods=[ _descriptor.MethodDescriptor( name="CreateJob", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile.proto index ea5113b3065b..268bb433ae14 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile.proto @@ -36,9 +36,7 @@ option objc_class_prefix = "CTS"; // Cloud Profile Discovery API definition // A resource that represents the profile for a job candidate (also referred to -// as a "single-source profile"). A profile belongs to a -// [Company][google.cloud.talent.v4beta1.Company], which is the -// company/organization that owns the profile. +// as a "single-source profile"). message Profile { // Required during profile update. // @@ -49,16 +47,12 @@ message Profile { // for example, "projects/api-test-project/tenants/foo/profiles/bar". string name = 1; - // Optional. - // - // Profile's id in client system if available. + // Optional. Profile's id in client system if available. // // The maximum number of bytes allowed is 100. string external_id = 2; - // Optional. - // - // The source description indicating where the profile is acquired. + // Optional. The source description indicating where the profile is acquired. // // For example, if a candidate profile is acquired from a resume, the user can // input "resume" here to indicate the source. @@ -66,20 +60,17 @@ message Profile { // The maximum number of bytes allowed is 100. string source = 3; - // Optional. - // - // The URI set by clients that links to this profile's client-side copy. + // Optional. The URI set by clients that links to this profile's client-side + // copy. // // The maximum number of bytes allowed is 4000. string uri = 4; - // Optional. - // - // The cluster id of the profile to associate with other profile(s) for the - // same candidate. + // Optional. The cluster id of the profile to associate with other profile(s) + // for the same candidate. // // This field should be generated by the customer. If a value is not provided, - // a random UUI is assigned to this field of the profile. + // a random UUID is assigned to this field of the profile. // // This is used to link multiple profiles to the same candidate. For example, // a client has a candidate with two profiles, where one was created recently @@ -90,56 +81,36 @@ message Profile { // referring to the same candidate. string group_id = 5; - // Optional. - // - // Indicates the hirable status of the candidate. + // Optional. Indicates the hirable status of the candidate. google.protobuf.BoolValue is_hirable = 6; - // Optional. - // - // The timestamp when the profile was first created at this source. + // Optional. The timestamp when the profile was first created at this source. google.protobuf.Timestamp create_time = 7; - // Optional. - // - // The timestamp when the profile was last updated at this source. + // Optional. The timestamp when the profile was last updated at this source. google.protobuf.Timestamp update_time = 8; - // Optional. - // - // The resume representing this profile. + // Optional. The resume representing this profile. Resume resume = 53; - // Optional. - // - // The names of the candidate this profile references. + // Optional. The names of the candidate this profile references. // // Currently only one person name is supported. repeated PersonName person_names = 11; - // Optional. - // - // The candidate's postal addresses. + // Optional. The candidate's postal addresses. repeated Address addresses = 12; - // Optional. - // - // The candidate's email addresses. + // Optional. The candidate's email addresses. repeated Email email_addresses = 13; - // Optional. - // - // The candidate's phone number(s). + // Optional. The candidate's phone number(s). repeated Phone phone_numbers = 14; - // Optional. - // - // The candidate's personal URIs. + // Optional. The candidate's personal URIs. repeated PersonalUri personal_uris = 15; - // Optional. - // - // Available contact information besides + // Optional. Available contact information besides // [addresses][google.cloud.talent.v4beta1.Profile.addresses], // [email_addresses][google.cloud.talent.v4beta1.Profile.email_addresses], // [phone_numbers][google.cloud.talent.v4beta1.Profile.phone_numbers] and @@ -147,11 +118,9 @@ message Profile { // example, Hang-out, Skype. repeated AdditionalContactInfo additional_contact_info = 16; - // Optional. - // - // The employment history records of the candidate. It's highly recommended - // to input this information as accurately as possible to help improve search - // quality. Here are some recommendations: + // Optional. The employment history records of the candidate. It's highly + // recommended to input this information as accurately as possible to help + // improve search quality. Here are some recommendations: // // * Specify the start and end dates of the employment records. // * List different employment types separately, no matter how minor the @@ -164,11 +133,9 @@ message Profile { // inputs. repeated EmploymentRecord employment_records = 17; - // Optional. - // - // The education history record of the candidate. It's highly recommended to - // input this information as accurately as possible to help improve search - // quality. Here are some recommendations: + // Optional. The education history record of the candidate. It's highly + // recommended to input this information as accurately as possible to help + // improve search quality. Here are some recommendations: // // * Specify the start and end dates of the education records. // * List each education type separately, no matter how minor the change is. @@ -180,33 +147,23 @@ message Profile { // inputs. repeated EducationRecord education_records = 18; - // Optional. - // - // The skill set of the candidate. It's highly recommended to provide as - // much information as possible to help improve the search quality. + // Optional. The skill set of the candidate. It's highly recommended to + // provide as much information as possible to help improve the search quality. repeated Skill skills = 19; - // Optional. - // - // The individual or collaborative activities which the candidate has - // participated in, for example, open-source projects, class assignments that - // aren't listed in + // Optional. The individual or collaborative activities which the candidate + // has participated in, for example, open-source projects, class assignments + // that aren't listed in // [employment_records][google.cloud.talent.v4beta1.Profile.employment_records]. repeated Activity activities = 20; - // Optional. - // - // The publications published by the candidate. + // Optional. The publications published by the candidate. repeated Publication publications = 21; - // Optional. - // - // The patents acquired by the candidate. + // Optional. The patents acquired by the candidate. repeated Patent patents = 22; - // Optional. - // - // The certifications acquired by the candidate. + // Optional. The certifications acquired by the candidate. repeated Certification certifications = 23; // Output only. The resource names of the candidate's applications. @@ -215,11 +172,9 @@ message Profile { // Output only. The resource names of the candidate's assignments. repeated string assignments = 48; - // Optional. - // - // A map of fields to hold both filterable and non-filterable custom profile - // attributes that aren't covered by the provided structured fields. See - // [CustomAttribute][google.cloud.talent.v4beta1.CustomAttribute] for more + // Optional. A map of fields to hold both filterable and non-filterable custom + // profile attributes that aren't covered by the provided structured fields. + // See [CustomAttribute][google.cloud.talent.v4beta1.CustomAttribute] for more // details. // // At most 100 filterable and at most 100 unfilterable keys are supported. If @@ -238,7 +193,9 @@ message Profile { // The maximum total byte size is 10KB. map custom_attributes = 26; - // Output only. Indicates if the profile is fully processed and searchable. + // Output only. Indicates if a summarized profile was created as part of the + // profile creation API call. This flag does not indicate whether a profile is + // searchable or not. bool processed = 27; // Output only. Keyword snippet shows how the search result is related to a @@ -263,9 +220,7 @@ message Resume { OTHER_RESUME_TYPE = 2; } - // Optional. - // - // Users can create a profile with only this field field, if + // Optional. Users can create a profile with only this field field, if // [resume_type][google.cloud.talent.v4beta1.Resume.resume_type] is // [HRXML][google.cloud.talent.v4beta1.Resume.ResumeType.HRXML]. For example, // the API parses this field and creates a profile with all structured fields @@ -276,12 +231,12 @@ message Resume { // // If this field is provided during profile creation or update, // any other structured data provided in the profile is ignored. The - // API populates these fields by parsing this field. + // API populates these fields by parsing this field. Note that the use of the + // functionality offered by this field to extract data from resumes is an + // Alpha feature and as such is not covered by any SLA. string structured_resume = 1; - // Optional. - // - // The format of + // Optional. The format of // [structured_resume][google.cloud.talent.v4beta1.Resume.structured_resume]. ResumeType resume_type = 2; } @@ -290,9 +245,7 @@ message Resume { message PersonName { // Resource that represents a person's structured name. message PersonStructuredName { - // Optional. - // - // Given/first name. + // Optional. Given/first name. // // It's derived from // [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] @@ -301,16 +254,12 @@ message PersonName { // Number of characters allowed is 100. string given_name = 1; - // Optional. - // - // Preferred given/first name or nickname. + // Optional. Preferred given/first name or nickname. // // Number of characters allowed is 100. string preferred_name = 6; - // Optional. - // - // Middle initial. + // Optional. Middle initial. // // It's derived from // [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] @@ -319,9 +268,7 @@ message PersonName { // Number of characters allowed is 20. string middle_initial = 2; - // Optional. - // - // Family/last name. + // Optional. Family/last name. // // It's derived from // [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] @@ -330,16 +277,12 @@ message PersonName { // Number of characters allowed is 100. string family_name = 3; - // Optional. - // - // Suffixes. + // Optional. Suffixes. // // Number of characters allowed is 20. repeated string suffixes = 4; - // Optional. - // - // Prefixes. + // Optional. Prefixes. // // Number of characters allowed is 20. repeated string prefixes = 5; @@ -349,23 +292,18 @@ message PersonName { // [formatted_name][google.cloud.talent.v4beta1.PersonName.formatted_name] or // [structured_name][google.cloud.talent.v4beta1.PersonName.structured_name]. oneof person_name { - // Optional. - // - // A string represents a person's full name. For example, "Dr. John Smith". + // Optional. A string represents a person's full name. For example, "Dr. + // John Smith". // // Number of characters allowed is 100. string formatted_name = 1; - // Optional. - // - // A person's name in a structured way (last name, first name, suffix, and - // so on.) + // Optional. A person's name in a structured way (last name, first name, + // suffix, and so on.) PersonStructuredName structured_name = 2; } - // Optional. - // - // Preferred name for the person. This field is ignored if + // Optional. Preferred name for the person. This field is ignored if // [structured_name][google.cloud.talent.v4beta1.PersonName.structured_name] // is provided. // @@ -375,9 +313,7 @@ message PersonName { // Resource that represents a address. message Address { - // Optional. - // - // The usage of the address. For example, SCHOOL, WORK, PERSONAL. + // Optional. The usage of the address. For example, SCHOOL, WORK, PERSONAL. ContactInfoUsage usage = 1; // The address of a person. It can be one of @@ -385,9 +321,7 @@ message Address { // or // [structured_address][google.cloud.talent.v4beta1.Address.structured_address]. oneof address { - // Optional. - // - // Unstructured address. + // Optional. Unstructured address. // // For example, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", // "Sunnyvale, California". @@ -395,29 +329,22 @@ message Address { // Number of characters allowed is 100. string unstructured_address = 2; - // Optional. - // - // Structured address that contains street address, city, state, country, - // and so on. + // Optional. Structured address that contains street address, city, state, + // country, and so on. google.type.PostalAddress structured_address = 3; } - // Optional. - // - // Indicates if it's the person's current address. + // Optional. Indicates if it's the person's current address. google.protobuf.BoolValue current = 4; } // Resource that represents a person's email address. message Email { - // Optional. - // - // The usage of the email address. For example, SCHOOL, WORK, PERSONAL. + // Optional. The usage of the email address. For example, SCHOOL, WORK, + // PERSONAL. ContactInfoUsage usage = 1; - // Optional. - // - // Email address. + // Optional. Email address. // // Number of characters allowed is 4,000. string email_address = 2; @@ -465,19 +392,13 @@ message Phone { MOBILE_OR_LANDLINE = 9; } - // Optional. - // - // The usage of the phone. For example, SCHOOL, WORK, PERSONAL. + // Optional. The usage of the phone. For example, SCHOOL, WORK, PERSONAL. ContactInfoUsage usage = 1; - // Optional. - // - // The phone type. For example, LANDLINE, MOBILE, FAX. + // Optional. The phone type. For example, LANDLINE, MOBILE, FAX. PhoneType type = 2; - // Optional. - // - // Phone number. + // Optional. Phone number. // // Any phone formats are supported and only exact matches are performed on // searches. For example, if a phone number in profile is provided in the @@ -487,9 +408,8 @@ message Phone { // Number of characters allowed is 20. string number = 3; - // Optional. - // - // When this number is available. Any descriptive string is expected. + // Optional. When this number is available. Any descriptive string is + // expected. // // Number of characters allowed is 100. string when_available = 4; @@ -497,9 +417,7 @@ message Phone { // Resource that represents a valid URI for a personal use. message PersonalUri { - // Optional. - // - // The personal URI. + // Optional. The personal URI. // // Number of characters allowed is 4,000. string uri = 1; @@ -508,23 +426,18 @@ message PersonalUri { // Resource that represents contact information other than phone, email, // URI and addresses. message AdditionalContactInfo { - // Optional. - // - // The usage of this contact method. For example, SCHOOL, WORK, PERSONAL. + // Optional. The usage of this contact method. For example, SCHOOL, WORK, + // PERSONAL. ContactInfoUsage usage = 1; - // Optional. - // - // The name of the contact method. + // Optional. The name of the contact method. // // For example, "hangout", "skype". // // Number of characters allowed is 100. string name = 2; - // Optional. - // - // The contact id. + // Optional. The contact id. // // Number of characters allowed is 100. string contact_id = 3; @@ -532,68 +445,48 @@ message AdditionalContactInfo { // Resource that represents an employment record of a candidate. message EmploymentRecord { - // Optional. - // - // Start date of the employment. + // Optional. Start date of the employment. google.type.Date start_date = 1; - // Optional. - // - // End date of the employment. + // Optional. End date of the employment. google.type.Date end_date = 2; - // Optional. - // - // The name of the employer company/organization. + // Optional. The name of the employer company/organization. // // For example, "Google", "Alphabet", and so on. // // Number of characters allowed is 100. string employer_name = 3; - // Optional. - // - // The division name of the employment. + // Optional. The division name of the employment. // // For example, division, department, client, and so on. // // Number of characters allowed is 100. string division_name = 4; - // Optional. - // - // The physical address of the employer. + // Optional. The physical address of the employer. Address address = 5; - // Optional. - // - // The job title of the employment. + // Optional. The job title of the employment. // // For example, "Software Engineer", "Data Scientist", and so on. // // Number of characters allowed is 100. string job_title = 6; - // Optional. - // - // The description of job content. + // Optional. The description of job content. // // Number of characters allowed is 100,000. string job_description = 7; - // Optional. - // - // If the jobs is a supervisor position. + // Optional. If the jobs is a supervisor position. google.protobuf.BoolValue is_supervisor = 8; - // Optional. - // - // If this employment is self-employed. + // Optional. If this employment is self-employed. google.protobuf.BoolValue is_self_employed = 9; - // Optional. - // - // If this employment is current. + // Optional. If this employment is current. google.protobuf.BoolValue is_current = 10; // Output only. The job title snippet shows how the @@ -620,33 +513,23 @@ message EmploymentRecord { // Resource that represents an education record of a candidate. message EducationRecord { - // Optional. - // - // The start date of the education. + // Optional. The start date of the education. google.type.Date start_date = 1; - // Optional. - // - // The end date of the education. + // Optional. The end date of the education. google.type.Date end_date = 2; - // Optional. - // - // The expected graduation date if currently pursuing a degree. + // Optional. The expected graduation date if currently pursuing a degree. google.type.Date expected_graduation_date = 3; - // Optional. - // - // The name of the school or institution. + // Optional. The name of the school or institution. // // For example, "Stanford University", "UC Berkeley", and so on. // // Number of characters allowed is 100. string school_name = 4; - // Optional. - // - // The physical address of the education institution. + // Optional. The physical address of the education institution. Address address = 5; // The degree information. It can be one of @@ -654,31 +537,23 @@ message EducationRecord { // or // [structured_degree][google.cloud.talent.v4beta1.EducationRecord.structured_degree]. oneof degree { - // Optional. - // - // The full description of the degree. + // Optional. The full description of the degree. // // For example, "Master of Science in Computer Science", "B.S in Math". // // Number of characters allowed is 100. string degree_description = 6; - // Optional. - // - // The structured notation of the degree. + // Optional. The structured notation of the degree. Degree structured_degree = 7; } - // Optional. - // - // The description of the education. + // Optional. The description of the education. // // Number of characters allowed is 100,000. string description = 8; - // Optional. - // - // If this education is current. + // Optional. If this education is current. google.protobuf.BoolValue is_current = 9; // Output only. The school name snippet shows how the @@ -698,23 +573,17 @@ message EducationRecord { // Resource that represents a degree pursuing or acquired by a candidate. message Degree { - // Optional. - // - // ISCED degree type. + // Optional. ISCED degree type. DegreeType degree_type = 1; - // Optional. - // - // Full Degree name. + // Optional. Full Degree name. // // For example, "B.S.", "Master of Arts", and so on. // // Number of characters allowed is 100. string degree_name = 2; - // Optional. - // - // Fields of study for the degree. + // Optional. Fields of study for the degree. // // For example, "Computer science", "engineering". // @@ -726,47 +595,33 @@ message Degree { // in by a candidate, for example, an open-source project, a class assignment, // and so on. message Activity { - // Optional. - // - // Activity display name. + // Optional. Activity display name. // // Number of characters allowed is 100. string display_name = 1; - // Optional. - // - // Activity description. + // Optional. Activity description. // // Number of characters allowed is 100,000. string description = 2; - // Optional. - // - // Activity URI. + // Optional. Activity URI. // // Number of characters allowed is 4,000. string uri = 3; - // Optional. - // - // The first creation date of the activity. + // Optional. The first creation date of the activity. google.type.Date create_date = 4; - // Optional. - // - // The last update date of the activity. + // Optional. The last update date of the activity. google.type.Date update_date = 5; - // Optional. - // - // A list of team members involved in this activity. + // Optional. A list of team members involved in this activity. // // Number of characters allowed is 100. repeated string team_members = 6; - // Optional. - // - // A list of skills used in this activity. + // Optional. A list of skills used in this activity. repeated Skill skills_used = 7; // Output only. Activity name snippet shows how the @@ -793,63 +648,45 @@ message Activity { // Resource that represents a publication resource of a candidate. message Publication { - // Optional. - // - // A list of author names. + // Optional. A list of author names. // // Number of characters allowed is 100. repeated string authors = 1; - // Optional. - // - // The title of the publication. + // Optional. The title of the publication. // // Number of characters allowed is 100. string title = 2; - // Optional. - // - // The description of the publication. + // Optional. The description of the publication. // // Number of characters allowed is 100,000. string description = 3; - // Optional. - // - // The journal name of the publication. + // Optional. The journal name of the publication. // // Number of characters allowed is 100. string journal = 4; - // Optional. - // - // Volume number. + // Optional. Volume number. // // Number of characters allowed is 100. string volume = 5; - // Optional. - // - // The publisher of the journal. + // Optional. The publisher of the journal. // // Number of characters allowed is 100. string publisher = 6; - // Optional. - // - // The publication date. + // Optional. The publication date. google.type.Date publication_date = 7; - // Optional. - // - // The publication type. + // Optional. The publication type. // // Number of characters allowed is 100. string publication_type = 8; - // Optional. - // - // ISBN number. + // Optional. ISBN number. // // Number of characters allowed is 100. string isbn = 9; @@ -857,60 +694,42 @@ message Publication { // Resource that represents the patent acquired by a candidate. message Patent { - // Optional. - // - // Name of the patent. + // Optional. Name of the patent. // // Number of characters allowed is 100. string display_name = 1; - // Optional. - // - // A list of inventors' names. + // Optional. A list of inventors' names. // // Number of characters allowed for each is 100. repeated string inventors = 2; - // Optional. - // - // The status of the patent. + // Optional. The status of the patent. // // Number of characters allowed is 100. string patent_status = 3; - // Optional. - // - // The date the last time the status of the patent was checked. + // Optional. The date the last time the status of the patent was checked. google.type.Date patent_status_date = 4; - // Optional. - // - // The date that the patent was filed. + // Optional. The date that the patent was filed. google.type.Date patent_filing_date = 5; - // Optional. - // - // The name of the patent office. + // Optional. The name of the patent office. // // Number of characters allowed is 100. string patent_office = 6; - // Optional. - // - // The number of the patent. + // Optional. The number of the patent. // // Number of characters allowed is 100. string patent_number = 7; - // Optional. - // - // The description of the patent. + // Optional. The description of the patent. // // Number of characters allowed is 100,000. string patent_description = 8; - // Optional. - // - // The skills used in this patent. + // Optional. The skills used in this patent. repeated Skill skills_used = 9; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_pb2.py index 14f84dc18523..aa8af69cffb1 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_pb2.py @@ -2651,9 +2651,7 @@ DESCRIPTOR=_PROFILE, __module__="google.cloud.talent_v4beta1.proto.profile_pb2", __doc__="""A resource that represents the profile for a job candidate (also - referred to as a "single-source profile"). A profile belongs to a - [Company][google.cloud.talent.v4beta1.Company], which is the - company/organization that owns the profile. + referred to as a "single-source profile"). Attributes: @@ -2663,22 +2661,22 @@ ants/{tenant\_id}/profiles/{profile\_id}", for example, "projects/api-test-project/tenants/foo/profiles/bar". external_id: - Optional. Profile's id in client system if available. The + Optional. Profile's id in client system if available. The maximum number of bytes allowed is 100. source: - Optional. The source description indicating where the profile + Optional. The source description indicating where the profile is acquired. For example, if a candidate profile is acquired from a resume, the user can input "resume" here to indicate the source. The maximum number of bytes allowed is 100. uri: - Optional. The URI set by clients that links to this profile's + Optional. The URI set by clients that links to this profile's client-side copy. The maximum number of bytes allowed is 4000. group_id: - Optional. The cluster id of the profile to associate with + Optional. The cluster id of the profile to associate with other profile(s) for the same candidate. This field should be generated by the customer. If a value is not provided, a - random UUI is assigned to this field of the profile. This is + random UUID is assigned to this field of the profile. This is used to link multiple profiles to the same candidate. For example, a client has a candidate with two profiles, where one was created recently and the other one was created 5 years @@ -2688,35 +2686,35 @@ and assign it when the second profile is created, indicating these two profiles are referring to the same candidate. is_hirable: - Optional. Indicates the hirable status of the candidate. + Optional. Indicates the hirable status of the candidate. create_time: - Optional. The timestamp when the profile was first created at + Optional. The timestamp when the profile was first created at this source. update_time: - Optional. The timestamp when the profile was last updated at + Optional. The timestamp when the profile was last updated at this source. resume: - Optional. The resume representing this profile. + Optional. The resume representing this profile. person_names: - Optional. The names of the candidate this profile references. + Optional. The names of the candidate this profile references. Currently only one person name is supported. addresses: - Optional. The candidate's postal addresses. + Optional. The candidate's postal addresses. email_addresses: - Optional. The candidate's email addresses. + Optional. The candidate's email addresses. phone_numbers: - Optional. The candidate's phone number(s). + Optional. The candidate's phone number(s). personal_uris: - Optional. The candidate's personal URIs. + Optional. The candidate's personal URIs. additional_contact_info: - Optional. Available contact information besides + Optional. Available contact information besides [addresses][google.cloud.talent.v4beta1.Profile.addresses], [e mail\_addresses][google.cloud.talent.v4beta1.Profile.email\_ad dresses], [phone\_numbers][google.cloud.talent.v4beta1.Profile .phone\_numbers] and [personal\_uris][google.cloud.talent.v4be ta1.Profile.personal\_uris]. For example, Hang-out, Skype. employment_records: - Optional. The employment history records of the candidate. + Optional. The employment history records of the candidate. It's highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: - Specify the start and end dates @@ -2728,7 +2726,7 @@ rrent] for the current employment if possible. If not, it's inferred from user inputs. education_records: - Optional. The education history record of the candidate. It's + Optional. The education history record of the candidate. It's highly recommended to input this information as accurately as possible to help improve search quality. Here are some recommendations: - Specify the start and end dates of the @@ -2740,21 +2738,21 @@ for the current education if possible. If not, it's inferred from user inputs. skills: - Optional. The skill set of the candidate. It's highly + Optional. The skill set of the candidate. It's highly recommended to provide as much information as possible to help improve the search quality. activities: - Optional. The individual or collaborative activities which - the candidate has participated in, for example, open-source + Optional. The individual or collaborative activities which the + candidate has participated in, for example, open-source projects, class assignments that aren't listed in [employment\ _records][google.cloud.talent.v4beta1.Profile.employment\_reco rds]. publications: - Optional. The publications published by the candidate. + Optional. The publications published by the candidate. patents: - Optional. The patents acquired by the candidate. + Optional. The patents acquired by the candidate. certifications: - Optional. The certifications acquired by the candidate. + Optional. The certifications acquired by the candidate. applications: Output only. The resource names of the candidate's applications. @@ -2762,7 +2760,7 @@ Output only. The resource names of the candidate's assignments. custom_attributes: - Optional. A map of fields to hold both filterable and non- + Optional. A map of fields to hold both filterable and non- filterable custom profile attributes that aren't covered by the provided structured fields. See [CustomAttribute][google.cloud.talent.v4beta1.CustomAttribute] @@ -2780,8 +2778,9 @@ is thrown for any request exceeding the limit. The maximum total byte size is 10KB. processed: - Output only. Indicates if the profile is fully processed and - searchable. + Output only. Indicates if a summarized profile was created as + part of the profile creation API call. This flag does not + indicate whether a profile is searchable or not. keyword_snippet: Output only. Keyword snippet shows how the search result is related to a search query. This is only returned in [SearchPro @@ -2805,7 +2804,7 @@ Attributes: structured_resume: - Optional. Users can create a profile with only this field + Optional. Users can create a profile with only this field field, if [resume\_type][google.cloud.talent.v4beta1.Resume.re sume\_type] is [HRXML][google.cloud.talent.v4beta1.Resume.ResumeType.HRXML]. @@ -2816,10 +2815,13 @@ so on. An error is thrown if this field cannot be parsed. If this field is provided during profile creation or update, any other structured data provided in the profile is ignored. The - API populates these fields by parsing this field. + API populates these fields by parsing this field. Note that + the use of the functionality offered by this field to extract + data from resumes is an Alpha feature and as such is not + covered by any SLA. resume_type: - Optional. The format of [structured\_resume][google.cloud.tal - ent.v4beta1.Resume.structured\_resume]. + Optional. The format of [structured\_resume][google.cloud.tale + nt.v4beta1.Resume.structured\_resume]. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Resume) ), @@ -2841,24 +2843,24 @@ Attributes: given_name: - Optional. Given/first name. It's derived from [formatted\_na - me][google.cloud.talent.v4beta1.PersonName.formatted\_name] if + Optional. Given/first name. It's derived from [formatted\_nam + e][google.cloud.talent.v4beta1.PersonName.formatted\_name] if not provided. Number of characters allowed is 100. preferred_name: - Optional. Preferred given/first name or nickname. Number of + Optional. Preferred given/first name or nickname. Number of characters allowed is 100. middle_initial: - Optional. Middle initial. It's derived from [formatted\_name - ][google.cloud.talent.v4beta1.PersonName.formatted\_name] if + Optional. Middle initial. It's derived from [formatted\_name] + [google.cloud.talent.v4beta1.PersonName.formatted\_name] if not provided. Number of characters allowed is 20. family_name: - Optional. Family/last name. It's derived from [formatted\_na - me][google.cloud.talent.v4beta1.PersonName.formatted\_name] if + Optional. Family/last name. It's derived from [formatted\_nam + e][google.cloud.talent.v4beta1.PersonName.formatted\_name] if not provided. Number of characters allowed is 100. suffixes: - Optional. Suffixes. Number of characters allowed is 20. + Optional. Suffixes. Number of characters allowed is 20. prefixes: - Optional. Prefixes. Number of characters allowed is 20. + Optional. Prefixes. Number of characters allowed is 20. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.PersonName.PersonStructuredName) ), @@ -2875,17 +2877,17 @@ red\_name][google.cloud.talent.v4beta1.PersonName.structured\_ name]. formatted_name: - Optional. A string represents a person's full name. For + Optional. A string represents a person's full name. For example, "Dr. John Smith". Number of characters allowed is 100. structured_name: - Optional. A person's name in a structured way (last name, + Optional. A person's name in a structured way (last name, first name, suffix, and so on.) preferred_name: - Optional. Preferred name for the person. This field is - ignored if [structured\_name][google.cloud.talent.v4beta1.Pers - onName.structured\_name] is provided. Number of characters - allowed is 100. + Optional. Preferred name for the person. This field is ignored + if [structured\_name][google.cloud.talent.v4beta1.PersonName.s + tructured\_name] is provided. Number of characters allowed is + 100. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.PersonName) ), @@ -2904,22 +2906,22 @@ Attributes: usage: - Optional. The usage of the address. For example, SCHOOL, - WORK, PERSONAL. + Optional. The usage of the address. For example, SCHOOL, WORK, + PERSONAL. address: The address of a person. It can be one of [unstructured\_addre ss][google.cloud.talent.v4beta1.Address.unstructured\_address] or [structured\_address][google.cloud.talent.v4beta1.Address.s tructured\_address]. unstructured_address: - Optional. Unstructured address. For example, "1600 + Optional. Unstructured address. For example, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", "Sunnyvale, California". Number of characters allowed is 100. structured_address: - Optional. Structured address that contains street address, + Optional. Structured address that contains street address, city, state, country, and so on. current: - Optional. Indicates if it's the person's current address. + Optional. Indicates if it's the person's current address. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Address) ), @@ -2937,10 +2939,10 @@ Attributes: usage: - Optional. The usage of the email address. For example, - SCHOOL, WORK, PERSONAL. + Optional. The usage of the email address. For example, SCHOOL, + WORK, PERSONAL. email_address: - Optional. Email address. Number of characters allowed is + Optional. Email address. Number of characters allowed is 4,000. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Email) @@ -2959,18 +2961,18 @@ Attributes: usage: - Optional. The usage of the phone. For example, SCHOOL, WORK, + Optional. The usage of the phone. For example, SCHOOL, WORK, PERSONAL. type: - Optional. The phone type. For example, LANDLINE, MOBILE, FAX. + Optional. The phone type. For example, LANDLINE, MOBILE, FAX. number: - Optional. Phone number. Any phone formats are supported and + Optional. Phone number. Any phone formats are supported and only exact matches are performed on searches. For example, if a phone number in profile is provided in the format of "(xxx)xxx-xxxx", in profile searches the same phone format has to be provided. Number of characters allowed is 20. when_available: - Optional. When this number is available. Any descriptive + Optional. When this number is available. Any descriptive string is expected. Number of characters allowed is 100. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Phone) @@ -2989,7 +2991,7 @@ Attributes: uri: - Optional. The personal URI. Number of characters allowed is + Optional. The personal URI. Number of characters allowed is 4,000. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.PersonalUri) @@ -3009,13 +3011,13 @@ Attributes: usage: - Optional. The usage of this contact method. For example, + Optional. The usage of this contact method. For example, SCHOOL, WORK, PERSONAL. name: - Optional. The name of the contact method. For example, + Optional. The name of the contact method. For example, "hangout", "skype". Number of characters allowed is 100. contact_id: - Optional. The contact id. Number of characters allowed is + Optional. The contact id. Number of characters allowed is 100. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.AdditionalContactInfo) @@ -3034,32 +3036,32 @@ Attributes: start_date: - Optional. Start date of the employment. + Optional. Start date of the employment. end_date: - Optional. End date of the employment. + Optional. End date of the employment. employer_name: - Optional. The name of the employer company/organization. For + Optional. The name of the employer company/organization. For example, "Google", "Alphabet", and so on. Number of characters allowed is 100. division_name: - Optional. The division name of the employment. For example, + Optional. The division name of the employment. For example, division, department, client, and so on. Number of characters allowed is 100. address: - Optional. The physical address of the employer. + Optional. The physical address of the employer. job_title: - Optional. The job title of the employment. For example, + Optional. The job title of the employment. For example, "Software Engineer", "Data Scientist", and so on. Number of characters allowed is 100. job_description: - Optional. The description of job content. Number of + Optional. The description of job content. Number of characters allowed is 100,000. is_supervisor: - Optional. If the jobs is a supervisor position. + Optional. If the jobs is a supervisor position. is_self_employed: - Optional. If this employment is self-employed. + Optional. If this employment is self-employed. is_current: - Optional. If this employment is current. + Optional. If this employment is current. job_title_snippet: Output only. The job title snippet shows how the [job\_title][ google.cloud.talent.v4beta1.EmploymentRecord.job\_title] is @@ -3095,34 +3097,34 @@ Attributes: start_date: - Optional. The start date of the education. + Optional. The start date of the education. end_date: - Optional. The end date of the education. + Optional. The end date of the education. expected_graduation_date: - Optional. The expected graduation date if currently pursuing - a degree. + Optional. The expected graduation date if currently pursuing a + degree. school_name: - Optional. The name of the school or institution. For - example, "Stanford University", "UC Berkeley", and so on. - Number of characters allowed is 100. + Optional. The name of the school or institution. For example, + "Stanford University", "UC Berkeley", and so on. Number of + characters allowed is 100. address: - Optional. The physical address of the education institution. + Optional. The physical address of the education institution. degree: The degree information. It can be one of [degree\_description] [google.cloud.talent.v4beta1.EducationRecord.degree\_descripti on] or [structured\_degree][google.cloud.talent.v4beta1.Educat ionRecord.structured\_degree]. degree_description: - Optional. The full description of the degree. For example, + Optional. The full description of the degree. For example, "Master of Science in Computer Science", "B.S in Math". Number of characters allowed is 100. structured_degree: - Optional. The structured notation of the degree. + Optional. The structured notation of the degree. description: - Optional. The description of the education. Number of + Optional. The description of the education. Number of characters allowed is 100,000. is_current: - Optional. If this education is current. + Optional. If this education is current. school_name_snippet: Output only. The school name snippet shows how the [school\_na me][google.cloud.talent.v4beta1.EducationRecord.school\_name] @@ -3152,12 +3154,12 @@ Attributes: degree_type: - Optional. ISCED degree type. + Optional. ISCED degree type. degree_name: - Optional. Full Degree name. For example, "B.S.", "Master of + Optional. Full Degree name. For example, "B.S.", "Master of Arts", and so on. Number of characters allowed is 100. fields_of_study: - Optional. Fields of study for the degree. For example, + Optional. Fields of study for the degree. For example, "Computer science", "engineering". Number of characters allowed is 100. """, @@ -3179,23 +3181,23 @@ class assignment, and so on. Attributes: display_name: - Optional. Activity display name. Number of characters - allowed is 100. + Optional. Activity display name. Number of characters allowed + is 100. description: - Optional. Activity description. Number of characters allowed + Optional. Activity description. Number of characters allowed is 100,000. uri: - Optional. Activity URI. Number of characters allowed is + Optional. Activity URI. Number of characters allowed is 4,000. create_date: - Optional. The first creation date of the activity. + Optional. The first creation date of the activity. update_date: - Optional. The last update date of the activity. + Optional. The last update date of the activity. team_members: - Optional. A list of team members involved in this activity. + Optional. A list of team members involved in this activity. Number of characters allowed is 100. skills_used: - Optional. A list of skills used in this activity. + Optional. A list of skills used in this activity. activity_name_snippet: Output only. Activity name snippet shows how the [display\_nam e][google.cloud.talent.v4beta1.Activity.display\_name] is @@ -3231,30 +3233,29 @@ class assignment, and so on. Attributes: authors: - Optional. A list of author names. Number of characters + Optional. A list of author names. Number of characters allowed is 100. title: - Optional. The title of the publication. Number of characters + Optional. The title of the publication. Number of characters allowed is 100. description: - Optional. The description of the publication. Number of + Optional. The description of the publication. Number of characters allowed is 100,000. journal: - Optional. The journal name of the publication. Number of + Optional. The journal name of the publication. Number of characters allowed is 100. volume: - Optional. Volume number. Number of characters allowed is - 100. + Optional. Volume number. Number of characters allowed is 100. publisher: - Optional. The publisher of the journal. Number of characters + Optional. The publisher of the journal. Number of characters allowed is 100. publication_date: - Optional. The publication date. + Optional. The publication date. publication_type: - Optional. The publication type. Number of characters allowed + Optional. The publication type. Number of characters allowed is 100. isbn: - Optional. ISBN number. Number of characters allowed is 100. + Optional. ISBN number. Number of characters allowed is 100. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Publication) ), @@ -3272,30 +3273,30 @@ class assignment, and so on. Attributes: display_name: - Optional. Name of the patent. Number of characters allowed - is 100. + Optional. Name of the patent. Number of characters allowed is + 100. inventors: - Optional. A list of inventors' names. Number of characters + Optional. A list of inventors' names. Number of characters allowed for each is 100. patent_status: - Optional. The status of the patent. Number of characters + Optional. The status of the patent. Number of characters allowed is 100. patent_status_date: - Optional. The date the last time the status of the patent was + Optional. The date the last time the status of the patent was checked. patent_filing_date: - Optional. The date that the patent was filed. + Optional. The date that the patent was filed. patent_office: - Optional. The name of the patent office. Number of - characters allowed is 100. + Optional. The name of the patent office. Number of characters + allowed is 100. patent_number: - Optional. The number of the patent. Number of characters + Optional. The number of the patent. Number of characters allowed is 100. patent_description: - Optional. The description of the patent. Number of - characters allowed is 100,000. + Optional. The description of the patent. Number of characters + allowed is 100,000. skills_used: - Optional. The skills used in this patent. + Optional. The skills used in this patent. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.Patent) ), diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service.proto index cc6f5ee24b6a..4c759f7e3790 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/common.proto"; import "google/cloud/talent/v4beta1/filters.proto"; import "google/cloud/talent/v4beta1/histogram.proto"; @@ -34,6 +35,11 @@ option objc_class_prefix = "CTS"; // A service that handles profile management, including profile CRUD, // enumeration and search. service ProfileService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Lists profiles by filter. The order is unspecified. rpc ListProfiles(ListProfilesRequest) returns (ListProfilesResponse) { option (google.api.http) = { @@ -91,34 +97,28 @@ service ProfileService { // List profiles request. message ListProfilesRequest { - // Required. - // - // The resource name of the tenant under which the job is created. + // Required. The resource name of the tenant under which the profile is + // created. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenants/foo". string parent = 1; - // Optional. - // - // The token that specifies the current offset (that is, starting result). + // Optional. The token that specifies the current offset (that is, starting + // result). // // Please set the value to // [ListProfilesResponse.next_page_token][google.cloud.talent.v4beta1.ListProfilesResponse.next_page_token] // to continue the list. string page_token = 2; - // Optional. - // - // The maximum number of profiles to be returned, at most 100. + // Optional. The maximum number of profiles to be returned, at most 100. // // Default is 100 unless a positive number smaller than 100 is specified. int32 page_size = 3; - // Optional. - // - // A field mask to specify the profile fields to be listed in response. - // All fields are listed if it is unset. + // Optional. A field mask to specify the profile fields to be listed in + // response. All fields are listed if it is unset. // // Valid values are: // @@ -138,25 +138,19 @@ message ListProfilesResponse { // Create profile request. message CreateProfileRequest { - // Required. - // - // The name of the tenant this profile belongs to. + // Required. The name of the tenant this profile belongs to. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenants/foo". string parent = 1; - // Required. - // - // The profile to be created. + // Required. The profile to be created. Profile profile = 2; } // Get profile request. message GetProfileRequest { - // Required. - // - // Resource name of the profile to get. + // Required. Resource name of the profile to get. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", @@ -166,50 +160,44 @@ message GetProfileRequest { // Update profile request message UpdateProfileRequest { - // Required. - // - // Profile to be updated. + // Required. Profile to be updated. Profile profile = 1; - // Optional. - // - // A field mask to specify the profile fields to update. + // Optional. A field mask to specify the profile fields to update. // // A full update is performed if it is unset. // // Valid values are: // - // * externalId + // * external_id // * source // * uri - // * isHirable - // * createTime - // * updateTime - // * resumeHrxml - // * personNames + // * is_hirable + // * create_time + // * update_time + // * resume + // * person_names // * addresses - // * emailAddresses - // * phoneNumbers - // * personalUris - // * additionalContactInfo - // * employmentRecords - // * educationRecords + // * email_addresses + // * phone_numbers + // * personal_uris + // * additional_contact_info + // * employment_records + // * education_records // * skills // * projects // * publications // * patents // * certifications - // * recruitingNotes - // * customAttributes - // * groupId + // * recruiting_notes + // * custom_attributes + // * group_id google.protobuf.FieldMask update_mask = 2; } // Delete profile request. message DeleteProfileRequest { - // Required. - // - // Resource name of the profile to be deleted. + // Required. Resource name of the profile to be deleted. // // The format is // "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", @@ -219,50 +207,38 @@ message DeleteProfileRequest { // The request body of the `SearchProfiles` call. message SearchProfilesRequest { - // Required. - // - // The resource name of the tenant to search within. + // Required. The resource name of the tenant to search within. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenants/foo". string parent = 1; - // Required. - // - // The meta information collected about the profile search user. This is used - // to improve the search quality of the service. These values are provided by - // users, and must be precise and consistent. + // Required. The meta information collected about the profile search user. + // This is used to improve the search quality of the service. These values are + // provided by users, and must be precise and consistent. RequestMetadata request_metadata = 2; - // Optional. - // - // Search query to execute. See + // Optional. Search query to execute. See // [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details. ProfileQuery profile_query = 3; - // Optional. - // - // A limit on the number of profiles returned in the search results. + // Optional. A limit on the number of profiles returned in the search results. // A value above the default value 10 can increase search response time. // // The maximum value allowed is 100. Otherwise an error is thrown. int32 page_size = 4; - // Optional. - // - // The pageToken, similar to offset enables users of the API to paginate - // through the search results. To retrieve the first page of results, set the - // pageToken to empty. The search response includes a + // Optional. The pageToken, similar to offset enables users of the API to + // paginate through the search results. To retrieve the first page of results, + // set the pageToken to empty. The search response includes a // [nextPageToken][google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token] // field that can be used to populate the pageToken field for the next page of // results. Using pageToken instead of offset increases the performance of the // API, especially compared to larger offset values. string page_token = 5; - // Optional. - // - // An integer that specifies the current offset (that is, starting result) in - // search results. This field is only considered if + // Optional. An integer that specifies the current offset (that is, starting + // result) in search results. This field is only considered if // [page_token][google.cloud.talent.v4beta1.SearchProfilesRequest.page_token] // is unset. // @@ -273,17 +249,13 @@ message SearchProfilesRequest { // pageSize = 10 and offset = 10 means to search from the second page. int32 offset = 6; - // Optional. - // - // This flag controls the spell-check feature. If `false`, the + // Optional. This flag controls the spell-check feature. If `false`, the // service attempts to correct a misspelled query. // // For example, "enginee" is corrected to "engineer". bool disable_spell_check = 7; - // Optional. - // - // The criteria that determines how search results are sorted. + // Optional. The criteria that determines how search results are sorted. // Defaults is "relevance desc" if no value is specified. // // Supported options are: @@ -314,17 +286,13 @@ message SearchProfilesRequest { // in ascending order. string order_by = 8; - // Optional. - // - // When sort by field is based on alphabetical order, sort values case - // sensitively (based on ASCII) when the value is set to true. Default value - // is case in-sensitive sort (false). + // Optional. When sort by field is based on alphabetical order, sort values + // case sensitively (based on ASCII) when the value is set to true. Default + // value is case in-sensitive sort (false). bool case_sensitive_sort = 9; - // Optional. - // - // A list of expressions specifies histogram requests against matching - // profiles for + // Optional. A list of expressions specifies histogram requests against + // matching profiles for // [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest]. // // The expression syntax looks like a function definition with optional @@ -406,6 +374,34 @@ message SearchProfilesRequest { // * count(numeric_custom_attribute["favorite_number"], // [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")]) repeated HistogramQuery histogram_queries = 10; + + // Optional. An id that uniquely identifies the result set of a + // [SearchProfiles][] call. The id should be retrieved from the + // [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse] + // message returned from a previous invocation of [SearchProfiles][]. + // + // A result set is an ordered list of search results. + // + // If this field is not set, a new result set is computed based on the + // [profile_query][google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query]. + // A new + // [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id] + // is returned as a handle to access this result set. + // + // If this field is set, the service will ignore the resource and + // [profile_query][google.cloud.talent.v4beta1.SearchProfilesRequest.profile_query] + // values, and simply retrieve a page of results from the corresponding result + // set. In this case, one and only one of [page_token] or [offset] must be + // set. + // + // A typical use case is to invoke + // [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest] + // without this field, then use the resulting + // [result_set_id][google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id] + // in + // [SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProfilesResponse] + // to page through the results. + string result_set_id = 12; } // Response of SearchProfiles method. @@ -433,6 +429,11 @@ message SearchProfilesResponse { // The profile entities that match the specified // [SearchProfilesRequest][google.cloud.talent.v4beta1.SearchProfilesRequest]. repeated SummarizedProfile summarized_profiles = 6; + + // An id that uniquely identifies the result set of a + // [SearchProfiles][google.cloud.talent.v4beta1.ProfileService.SearchProfiles] + // call for consistent results. + string result_set_id = 7; } // Output only. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service_pb2.py index be567fca72fd..758c93b58622 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/profile_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( common_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2, ) @@ -40,10 +41,11 @@ "\n\037com.google.cloud.talent.v4beta1B\023ProfileServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n7google/cloud/talent_v4beta1/proto/profile_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/filters.proto\x1a\x31google/cloud/talent_v4beta1/proto/histogram.proto\x1a/google/cloud/talent_v4beta1/proto/profile.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"{\n\x13ListProfilesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12-\n\tread_mask\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"g\n\x14ListProfilesResponse\x12\x36\n\x08profiles\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t"]\n\x14\x43reateProfileRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x35\n\x07profile\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile"!\n\x11GetProfileRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"~\n\x14UpdateProfileRequest\x12\x35\n\x07profile\x18\x01 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"$\n\x14\x44\x65leteProfileRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"\xfc\x02\n\x15SearchProfilesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x46\n\x10request_metadata\x18\x02 \x01(\x0b\x32,.google.cloud.talent.v4beta1.RequestMetadata\x12@\n\rprofile_query\x18\x03 \x01(\x0b\x32).google.cloud.talent.v4beta1.ProfileQuery\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12\x1b\n\x13\x64isable_spell_check\x18\x07 \x01(\x08\x12\x10\n\x08order_by\x18\x08 \x01(\t\x12\x1b\n\x13\x63\x61se_sensitive_sort\x18\t \x01(\x08\x12\x46\n\x11histogram_queries\x18\n \x03(\x0b\x32+.google.cloud.talent.v4beta1.HistogramQuery"\xfc\x02\n\x16SearchProfilesResponse\x12\x1c\n\x14\x65stimated_total_size\x18\x01 \x01(\x03\x12I\n\x10spell_correction\x18\x02 \x01(\x0b\x32/.google.cloud.talent.v4beta1.SpellingCorrection\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x12\x17\n\x0fnext_page_token\x18\x04 \x01(\t\x12R\n\x17histogram_query_results\x18\x05 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.HistogramQueryResult\x12K\n\x13summarized_profiles\x18\x06 \x03(\x0b\x32..google.cloud.talent.v4beta1.SummarizedProfile"\x82\x01\n\x11SummarizedProfile\x12\x36\n\x08profiles\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12\x35\n\x07summary\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile2\xff\x07\n\x0eProfileService\x12\xac\x01\n\x0cListProfiles\x12\x30.google.cloud.talent.v4beta1.ListProfilesRequest\x1a\x31.google.cloud.talent.v4beta1.ListProfilesResponse"7\x82\xd3\xe4\x93\x02\x31\x12//v4beta1/{parent=projects/*/tenants/*}/profiles\x12\xa4\x01\n\rCreateProfile\x12\x31.google.cloud.talent.v4beta1.CreateProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile":\x82\xd3\xe4\x93\x02\x34"//v4beta1/{parent=projects/*/tenants/*}/profiles:\x01*\x12\x9b\x01\n\nGetProfile\x12..google.cloud.talent.v4beta1.GetProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile"7\x82\xd3\xe4\x93\x02\x31\x12//v4beta1/{name=projects/*/tenants/*/profiles/*}\x12\xac\x01\n\rUpdateProfile\x12\x31.google.cloud.talent.v4beta1.UpdateProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile"B\x82\xd3\xe4\x93\x02<27/v4beta1/{profile.name=projects/*/tenants/*/profiles/*}:\x01*\x12\x93\x01\n\rDeleteProfile\x12\x31.google.cloud.talent.v4beta1.DeleteProfileRequest\x1a\x16.google.protobuf.Empty"7\x82\xd3\xe4\x93\x02\x31*//v4beta1/{name=projects/*/tenants/*/profiles/*}\x12\xb3\x01\n\x0eSearchProfiles\x12\x32.google.cloud.talent.v4beta1.SearchProfilesRequest\x1a\x33.google.cloud.talent.v4beta1.SearchProfilesResponse"8\x82\xd3\xe4\x93\x02\x32"-/v4beta1/{parent=projects/*/tenants/*}:search:\x01*B\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13ProfileServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n7google/cloud/talent_v4beta1/proto/profile_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a/google/cloud/talent_v4beta1/proto/filters.proto\x1a\x31google/cloud/talent_v4beta1/proto/histogram.proto\x1a/google/cloud/talent_v4beta1/proto/profile.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"{\n\x13ListProfilesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05\x12-\n\tread_mask\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"g\n\x14ListProfilesResponse\x12\x36\n\x08profiles\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t"]\n\x14\x43reateProfileRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x35\n\x07profile\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile"!\n\x11GetProfileRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"~\n\x14UpdateProfileRequest\x12\x35\n\x07profile\x18\x01 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"$\n\x14\x44\x65leteProfileRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"\x93\x03\n\x15SearchProfilesRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x46\n\x10request_metadata\x18\x02 \x01(\x0b\x32,.google.cloud.talent.v4beta1.RequestMetadata\x12@\n\rprofile_query\x18\x03 \x01(\x0b\x32).google.cloud.talent.v4beta1.ProfileQuery\x12\x11\n\tpage_size\x18\x04 \x01(\x05\x12\x12\n\npage_token\x18\x05 \x01(\t\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12\x1b\n\x13\x64isable_spell_check\x18\x07 \x01(\x08\x12\x10\n\x08order_by\x18\x08 \x01(\t\x12\x1b\n\x13\x63\x61se_sensitive_sort\x18\t \x01(\x08\x12\x46\n\x11histogram_queries\x18\n \x03(\x0b\x32+.google.cloud.talent.v4beta1.HistogramQuery\x12\x15\n\rresult_set_id\x18\x0c \x01(\t"\x93\x03\n\x16SearchProfilesResponse\x12\x1c\n\x14\x65stimated_total_size\x18\x01 \x01(\x03\x12I\n\x10spell_correction\x18\x02 \x01(\x0b\x32/.google.cloud.talent.v4beta1.SpellingCorrection\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata\x12\x17\n\x0fnext_page_token\x18\x04 \x01(\t\x12R\n\x17histogram_query_results\x18\x05 \x03(\x0b\x32\x31.google.cloud.talent.v4beta1.HistogramQueryResult\x12K\n\x13summarized_profiles\x18\x06 \x03(\x0b\x32..google.cloud.talent.v4beta1.SummarizedProfile\x12\x15\n\rresult_set_id\x18\x07 \x01(\t"\x82\x01\n\x11SummarizedProfile\x12\x36\n\x08profiles\x18\x01 \x03(\x0b\x32$.google.cloud.talent.v4beta1.Profile\x12\x35\n\x07summary\x18\x02 \x01(\x0b\x32$.google.cloud.talent.v4beta1.Profile2\xed\x08\n\x0eProfileService\x12\xac\x01\n\x0cListProfiles\x12\x30.google.cloud.talent.v4beta1.ListProfilesRequest\x1a\x31.google.cloud.talent.v4beta1.ListProfilesResponse"7\x82\xd3\xe4\x93\x02\x31\x12//v4beta1/{parent=projects/*/tenants/*}/profiles\x12\xa4\x01\n\rCreateProfile\x12\x31.google.cloud.talent.v4beta1.CreateProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile":\x82\xd3\xe4\x93\x02\x34"//v4beta1/{parent=projects/*/tenants/*}/profiles:\x01*\x12\x9b\x01\n\nGetProfile\x12..google.cloud.talent.v4beta1.GetProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile"7\x82\xd3\xe4\x93\x02\x31\x12//v4beta1/{name=projects/*/tenants/*/profiles/*}\x12\xac\x01\n\rUpdateProfile\x12\x31.google.cloud.talent.v4beta1.UpdateProfileRequest\x1a$.google.cloud.talent.v4beta1.Profile"B\x82\xd3\xe4\x93\x02<27/v4beta1/{profile.name=projects/*/tenants/*/profiles/*}:\x01*\x12\x93\x01\n\rDeleteProfile\x12\x31.google.cloud.talent.v4beta1.DeleteProfileRequest\x1a\x16.google.protobuf.Empty"7\x82\xd3\xe4\x93\x02\x31*//v4beta1/{name=projects/*/tenants/*/profiles/*}\x12\xb3\x01\n\x0eSearchProfiles\x12\x32.google.cloud.talent.v4beta1.SearchProfilesRequest\x1a\x33.google.cloud.talent.v4beta1.SearchProfilesResponse"8\x82\xd3\xe4\x93\x02\x32"-/v4beta1/{parent=projects/*/tenants/*}:search:\x01*\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13ProfileServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_filters__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_histogram__pb2.DESCRIPTOR, @@ -142,8 +144,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=378, - serialized_end=501, + serialized_start=403, + serialized_end=526, ) @@ -199,8 +201,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=503, - serialized_end=606, + serialized_start=528, + serialized_end=631, ) @@ -256,8 +258,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=608, - serialized_end=701, + serialized_start=633, + serialized_end=726, ) @@ -295,8 +297,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=703, - serialized_end=736, + serialized_start=728, + serialized_end=761, ) @@ -352,8 +354,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=738, - serialized_end=864, + serialized_start=763, + serialized_end=889, ) @@ -391,8 +393,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=866, - serialized_end=902, + serialized_start=891, + serialized_end=927, ) @@ -583,6 +585,24 @@ serialized_options=None, file=DESCRIPTOR, ), + _descriptor.FieldDescriptor( + name="result_set_id", + full_name="google.cloud.talent.v4beta1.SearchProfilesRequest.result_set_id", + index=10, + number=12, + type=9, + cpp_type=9, + label=1, + has_default_value=False, + default_value=_b("").decode("utf-8"), + message_type=None, + enum_type=None, + containing_type=None, + is_extension=False, + extension_scope=None, + serialized_options=None, + file=DESCRIPTOR, + ), ], extensions=[], nested_types=[], @@ -592,8 +612,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=905, - serialized_end=1285, + serialized_start=930, + serialized_end=1333, ) @@ -712,6 +732,24 @@ serialized_options=None, file=DESCRIPTOR, ), + _descriptor.FieldDescriptor( + name="result_set_id", + full_name="google.cloud.talent.v4beta1.SearchProfilesResponse.result_set_id", + index=6, + number=7, + type=9, + cpp_type=9, + label=1, + has_default_value=False, + default_value=_b("").decode("utf-8"), + message_type=None, + enum_type=None, + containing_type=None, + is_extension=False, + extension_scope=None, + serialized_options=None, + file=DESCRIPTOR, + ), ], extensions=[], nested_types=[], @@ -721,8 +759,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=1288, - serialized_end=1668, + serialized_start=1336, + serialized_end=1739, ) @@ -778,8 +816,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=1671, - serialized_end=1801, + serialized_start=1742, + serialized_end=1872, ) _LISTPROFILESREQUEST.fields_by_name[ @@ -868,21 +906,21 @@ Attributes: parent: - Required. The resource name of the tenant under which the job - is created. The format is + Required. The resource name of the tenant under which the + profile is created. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". page_token: - Optional. The token that specifies the current offset (that + Optional. The token that specifies the current offset (that is, starting result). Please set the value to [ListProfilesRe sponse.next\_page\_token][google.cloud.talent.v4beta1.ListProf ilesResponse.next\_page\_token] to continue the list. page_size: - Optional. The maximum number of profiles to be returned, at + Optional. The maximum number of profiles to be returned, at most 100. Default is 100 unless a positive number smaller than 100 is specified. read_mask: - Optional. A field mask to specify the profile fields to be + Optional. A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are: - name """, @@ -923,11 +961,11 @@ Attributes: parent: - Required. The name of the tenant this profile belongs to. - The format is "projects/{project\_id}/tenants/{tenant\_id}", - for example, "projects/api-test-project/tenants/foo". + Required. The name of the tenant this profile belongs to. The + format is "projects/{project\_id}/tenants/{tenant\_id}", for + example, "projects/api-test-project/tenants/foo". profile: - Required. The profile to be created. + Required. The profile to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateProfileRequest) ), @@ -945,7 +983,7 @@ Attributes: name: - Required. Resource name of the profile to get. The format is + Required. Resource name of the profile to get. The format is "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile \_id}", for example, "projects/api-test- project/tenants/foo/profiles/bar". @@ -966,17 +1004,17 @@ Attributes: profile: - Required. Profile to be updated. + Required. Profile to be updated. update_mask: - Optional. A field mask to specify the profile fields to + Optional. A field mask to specify the profile fields to update. A full update is performed if it is unset. Valid - values are: - externalId - source - uri - isHirable - - createTime - updateTime - resumeHrxml - personNames - - addresses - emailAddresses - phoneNumbers - personalUris - - additionalContactInfo - employmentRecords - educationRecords - - skills - projects - publications - patents - - certifications - recruitingNotes - customAttributes - - groupId + values are: - external\_id - source - uri - is\_hirable - + create\_time - update\_time - resume - person\_names - + addresses - email\_addresses - phone\_numbers - + personal\_uris - additional\_contact\_info - + employment\_records - education\_records - skills - + projects - publications - patents - certifications - + recruiting\_notes - custom\_attributes - group\_id """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.UpdateProfileRequest) ), @@ -994,7 +1032,7 @@ Attributes: name: - Required. Resource name of the profile to be deleted. The + Required. Resource name of the profile to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}/profile s/{profile\_id}", for example, "projects/api-test- project/tenants/foo/profiles/bar". @@ -1015,25 +1053,25 @@ Attributes: parent: - Required. The resource name of the tenant to search within. + Required. The resource name of the tenant to search within. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". request_metadata: - Required. The meta information collected about the profile + Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent. profile_query: - Optional. Search query to execute. See + Optional. Search query to execute. See [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details. page_size: - Optional. A limit on the number of profiles returned in the + Optional. A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown. page_token: - Optional. The pageToken, similar to offset enables users of + Optional. The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a [nextPageToken][google.cloud.talent @@ -1043,7 +1081,7 @@ performance of the API, especially compared to larger offset values. offset: - Optional. An integer that specifies the current offset (that + Optional. An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if [page\_token][google.cloud.talent.v4beta1.Search ProfilesRequest.page\_token] is unset. The maximum allowed @@ -1053,11 +1091,11 @@ example pageSize = 10 and offset = 10 means to search from the second page. disable_spell_check: - Optional. This flag controls the spell-check feature. If + Optional. This flag controls the spell-check feature. If ``false``, the service attempts to correct a misspelled query. For example, "enginee" is corrected to "engineer". order_by: - Optional. The criteria that determines how search results are + Optional. The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are: - "relevance desc": By descending relevance, as determined by the API algorithms. - @@ -1079,12 +1117,12 @@ .family\_name][google.cloud.talent.v4beta1.PersonName.PersonSt ructuredName.family\_name] in ascending order. case_sensitive_sort: - Optional. When sort by field is based on alphabetical order, + Optional. When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false). histogram_queries: - Optional. A list of expressions specifies histogram requests + Optional. A list of expressions specifies histogram requests against matching profiles for [SearchProfilesRequest][google.c loud.talent.v4beta1.SearchProfilesRequest]. The expression syntax looks like a function definition with optional @@ -1151,6 +1189,28 @@ count(numeric\_custom\_attribute["favorite\_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non- negative")]) + result_set_id: + Optional. An id that uniquely identifies the result set of a + [SearchProfiles][] call. The id should be retrieved from the [ + SearchProfilesResponse][google.cloud.talent.v4beta1.SearchProf + ilesResponse] message returned from a previous invocation of + [SearchProfiles][]. A result set is an ordered list of search + results. If this field is not set, a new result set is + computed based on the [profile\_query][google.cloud.talent.v4b + eta1.SearchProfilesRequest.profile\_query]. A new [result\_set + \_id][google.cloud.talent.v4beta1.SearchProfilesRequest.result + \_set\_id] is returned as a handle to access this result set. + If this field is set, the service will ignore the resource and + [profile\_query][google.cloud.talent.v4beta1.SearchProfilesReq + uest.profile\_query] values, and simply retrieve a page of + results from the corresponding result set. In this case, one + and only one of [page\_token] or [offset] must be set. A + typical use case is to invoke [SearchProfilesRequest][google.c + loud.talent.v4beta1.SearchProfilesRequest] without this field, + then use the resulting [result\_set\_id][google.cloud.talent.v + 4beta1.SearchProfilesRequest.result\_set\_id] in [SearchProfil + esResponse][google.cloud.talent.v4beta1.SearchProfilesResponse + ] to page through the results. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.SearchProfilesRequest) ), @@ -1185,6 +1245,10 @@ summarized_profiles: The profile entities that match the specified [SearchProfilesR equest][google.cloud.talent.v4beta1.SearchProfilesRequest]. + result_set_id: + An id that uniquely identifies the result set of a [SearchProf + iles][google.cloud.talent.v4beta1.ProfileService.SearchProfile + s] call for consistent results. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.SearchProfilesResponse) ), @@ -1235,9 +1299,11 @@ full_name="google.cloud.talent.v4beta1.ProfileService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=1804, - serialized_end=2827, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=1875, + serialized_end=3008, methods=[ _descriptor.MethodDescriptor( name="ListProfiles", diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant.proto index 8eef5e3d73ea..88deddecaebf 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant.proto @@ -17,8 +17,8 @@ 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; @@ -54,26 +54,24 @@ message Tenant { // "projects/api-test-project/tenants/foo". string name = 1; - // Required. - // - // Client side tenant identifier, used to uniquely identify the tenant. + // Required. Client side tenant identifier, used to uniquely identify the + // tenant. // // The maximum number of allowed characters is 255. string external_id = 2; - // Optional. + // Optional. Indicates whether data owned by this tenant may be used to + // provide product improvements across other tenants. // - // Indicates whether data owned by this tenant may be used to provide product - // improvements across other tenants. - // - // Defaults behavior is [DataUsageType.ISOLATED][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED] if it's unset. + // Defaults behavior is + // [DataUsageType.ISOLATED][google.cloud.talent.v4beta1.Tenant.DataUsageType.ISOLATED] + // if it's unset. DataUsageType usage_type = 3; - // Optional. - // - // A list of keys of filterable [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], whose - // corresponding `string_values` are used in keyword searches. Profiles with - // `string_values` under these specified field keys are returned if any + // Optional. A list of keys of filterable + // [Profile.custom_attributes][google.cloud.talent.v4beta1.Profile.custom_attributes], + // whose corresponding `string_values` are used in keyword searches. Profiles + // with `string_values` under these specified field keys are returned if any // of the values match the search keyword. Custom field values with // parenthesis, brackets and special symbols are not searchable as-is, // and must be surrounded by quotes. diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_pb2.py index 5e70fa33c3cb..19abb1f09817 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_pb2.py @@ -15,10 +15,10 @@ _sym_db = _symbol_database.Default() +from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 from google.cloud.talent_v4beta1.proto import ( common_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2, ) -from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 DESCRIPTOR = _descriptor.FileDescriptor( @@ -29,11 +29,11 @@ "\n\037com.google.cloud.talent.v4beta1B\023TenantResourceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n.google/cloud/talent_v4beta1/proto/tenant.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a\x1cgoogle/api/annotations.proto"\xf8\x01\n\x06Tenant\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x65xternal_id\x18\x02 \x01(\t\x12\x45\n\nusage_type\x18\x03 \x01(\x0e\x32\x31.google.cloud.talent.v4beta1.Tenant.DataUsageType\x12\x34\n,keyword_searchable_profile_custom_attributes\x18\x04 \x03(\t"N\n\rDataUsageType\x12\x1f\n\x1b\x44\x41TA_USAGE_TYPE_UNSPECIFIED\x10\x00\x12\x0e\n\nAGGREGATED\x10\x01\x12\x0c\n\x08ISOLATED\x10\x02\x42\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13TenantResourceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n.google/cloud/talent_v4beta1/proto/tenant.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto"\xf8\x01\n\x06Tenant\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x65xternal_id\x18\x02 \x01(\t\x12\x45\n\nusage_type\x18\x03 \x01(\x0e\x32\x31.google.cloud.talent.v4beta1.Tenant.DataUsageType\x12\x34\n,keyword_searchable_profile_custom_attributes\x18\x04 \x03(\t"N\n\rDataUsageType\x12\x1f\n\x1b\x44\x41TA_USAGE_TYPE_UNSPECIFIED\x10\x00\x12\x0e\n\nAGGREGATED\x10\x01\x12\x0c\n\x08ISOLATED\x10\x02\x42\x81\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x13TenantResourceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ - google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, ], ) @@ -183,18 +183,18 @@ "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". external_id: - Required. Client side tenant identifier, used to uniquely + Required. Client side tenant identifier, used to uniquely identify the tenant. The maximum number of allowed characters is 255. usage_type: - Optional. Indicates whether data owned by this tenant may be + Optional. Indicates whether data owned by this tenant may be used to provide product improvements across other tenants. Defaults behavior is [DataUsageType.ISOLATED][google.cloud.tal ent.v4beta1.Tenant.DataUsageType.ISOLATED] if it's unset. keyword_searchable_profile_custom_attributes: - Optional. A list of keys of filterable [Profile.custom\_attri - butes][google.cloud.talent.v4beta1.Profile.custom\_attributes] - , whose corresponding ``string_values`` are used in keyword + Optional. A list of keys of filterable [Profile.custom\_attrib + utes][google.cloud.talent.v4beta1.Profile.custom\_attributes], + whose corresponding ``string_values`` are used in keyword searches. Profiles with ``string_values`` under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service.proto b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service.proto index 5af4fd8c587e..33b7f53845e4 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service.proto +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service.proto @@ -18,6 +18,7 @@ syntax = "proto3"; package google.cloud.talent.v4beta1; import "google/api/annotations.proto"; +import "google/api/client.proto"; import "google/cloud/talent/v4beta1/common.proto"; import "google/cloud/talent/v4beta1/tenant.proto"; import "google/protobuf/empty.proto"; @@ -31,6 +32,11 @@ option objc_class_prefix = "CTS"; // A service that handles tenant management, including CRUD and enumeration. service TenantService { + option (google.api.default_host) = "jobs.googleapis.com"; + option (google.api.oauth_scopes) = + "https://www.googleapis.com/auth/cloud-platform," + "https://www.googleapis.com/auth/jobs"; + // Creates a new tenant entity. rpc CreateTenant(CreateTenantRequest) returns (Tenant) { option (google.api.http) = { @@ -71,25 +77,19 @@ service TenantService { // The Request of the CreateTenant method. message CreateTenantRequest { - // Required. - // - // Resource name of the project under which the tenant is created. + // Required. Resource name of the project under which the tenant is created. // // The format is "projects/{project_id}", for example, // "projects/api-test-project". string parent = 1; - // Required. - // - // The tenant to be created. + // Required. The tenant to be created. Tenant tenant = 2; } // Request for getting a tenant by name. message GetTenantRequest { - // Required. - // - // The resource name of the tenant to be retrieved. + // Required. The resource name of the tenant to be retrieved. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenants/foo". @@ -98,27 +98,28 @@ message GetTenantRequest { // Request for updating a specified tenant. message UpdateTenantRequest { - // Required. - // - // The tenant resource to replace the current resource in the system. + // Required. The tenant resource to replace the current resource in the + // system. Tenant tenant = 1; // Optional but strongly recommended for the best service // experience. // - // If [update_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask] is provided, only the specified fields in - // [tenant][google.cloud.talent.v4beta1.UpdateTenantRequest.tenant] are updated. Otherwise all the fields are updated. + // If + // [update_mask][google.cloud.talent.v4beta1.UpdateTenantRequest.update_mask] + // is provided, only the specified fields in + // [tenant][google.cloud.talent.v4beta1.UpdateTenantRequest.tenant] are + // updated. Otherwise all the fields are updated. // // A field mask to specify the tenant fields to be updated. Only - // top level fields of [Tenant][google.cloud.talent.v4beta1.Tenant] are supported. + // top level fields of [Tenant][google.cloud.talent.v4beta1.Tenant] are + // supported. google.protobuf.FieldMask update_mask = 2; } // Request to delete a tenant. message DeleteTenantRequest { - // Required. - // - // The resource name of the tenant to be deleted. + // Required. The resource name of the tenant to be deleted. // // The format is "projects/{project_id}/tenants/{tenant_id}", for example, // "projects/api-test-project/tenants/foo". @@ -127,22 +128,16 @@ message DeleteTenantRequest { // List tenants for which the client has ACL visibility. message ListTenantsRequest { - // Required. - // - // Resource name of the project under which the tenant is created. + // Required. Resource name of the project under which the tenant is created. // // The format is "projects/{project_id}", for example, // "projects/api-test-project". string parent = 1; - // Optional. - // - // The starting indicator from which to return results. + // Optional. The starting indicator from which to return results. string page_token = 2; - // Optional. - // - // The maximum number of tenants to be returned, at most 100. + // Optional. The maximum number of tenants to be returned, at most 100. // Default is 100 if a non-positive number is provided. int32 page_size = 3; } diff --git a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service_pb2.py b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service_pb2.py index e3af5297ad80..abfe7fa50d0e 100644 --- a/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service_pb2.py +++ b/packages/google-cloud-talent/google/cloud/talent_v4beta1/proto/tenant_service_pb2.py @@ -16,6 +16,7 @@ from google.api import annotations_pb2 as google_dot_api_dot_annotations__pb2 +from google.api import client_pb2 as google_dot_api_dot_client__pb2 from google.cloud.talent_v4beta1.proto import ( common_pb2 as google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2, ) @@ -34,10 +35,11 @@ "\n\037com.google.cloud.talent.v4beta1B\022TenantServiceProtoP\001ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\242\002\003CTS" ), serialized_pb=_b( - '\n6google/cloud/talent_v4beta1/proto/tenant_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a.google/cloud/talent_v4beta1/proto/tenant.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"Z\n\x13\x43reateTenantRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x33\n\x06tenant\x18\x02 \x01(\x0b\x32#.google.cloud.talent.v4beta1.Tenant" \n\x10GetTenantRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"{\n\x13UpdateTenantRequest\x12\x33\n\x06tenant\x18\x01 \x01(\x0b\x32#.google.cloud.talent.v4beta1.Tenant\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"#\n\x13\x44\x65leteTenantRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"K\n\x12ListTenantsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05"\xa5\x01\n\x13ListTenantsResponse\x12\x34\n\x07tenants\x18\x01 \x03(\x0b\x32#.google.cloud.talent.v4beta1.Tenant\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\x82\x06\n\rTenantService\x12\x96\x01\n\x0c\x43reateTenant\x12\x30.google.cloud.talent.v4beta1.CreateTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant"/\x82\xd3\xe4\x93\x02)"$/v4beta1/{parent=projects/*}/tenants:\x01*\x12\x8d\x01\n\tGetTenant\x12-.google.cloud.talent.v4beta1.GetTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant",\x82\xd3\xe4\x93\x02&\x12$/v4beta1/{name=projects/*/tenants/*}\x12\x9d\x01\n\x0cUpdateTenant\x12\x30.google.cloud.talent.v4beta1.UpdateTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant"6\x82\xd3\xe4\x93\x02\x30\x32+/v4beta1/{tenant.name=projects/*/tenants/*}:\x01*\x12\x86\x01\n\x0c\x44\x65leteTenant\x12\x30.google.cloud.talent.v4beta1.DeleteTenantRequest\x1a\x16.google.protobuf.Empty",\x82\xd3\xe4\x93\x02&*$/v4beta1/{name=projects/*/tenants/*}\x12\x9e\x01\n\x0bListTenants\x12/.google.cloud.talent.v4beta1.ListTenantsRequest\x1a\x30.google.cloud.talent.v4beta1.ListTenantsResponse",\x82\xd3\xe4\x93\x02&\x12$/v4beta1/{parent=projects/*}/tenantsB\x80\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x12TenantServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' + '\n6google/cloud/talent_v4beta1/proto/tenant_service.proto\x12\x1bgoogle.cloud.talent.v4beta1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a.google/cloud/talent_v4beta1/proto/common.proto\x1a.google/cloud/talent_v4beta1/proto/tenant.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto"Z\n\x13\x43reateTenantRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x33\n\x06tenant\x18\x02 \x01(\x0b\x32#.google.cloud.talent.v4beta1.Tenant" \n\x10GetTenantRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"{\n\x13UpdateTenantRequest\x12\x33\n\x06tenant\x18\x01 \x01(\x0b\x32#.google.cloud.talent.v4beta1.Tenant\x12/\n\x0bupdate_mask\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.FieldMask"#\n\x13\x44\x65leteTenantRequest\x12\x0c\n\x04name\x18\x01 \x01(\t"K\n\x12ListTenantsRequest\x12\x0e\n\x06parent\x18\x01 \x01(\t\x12\x12\n\npage_token\x18\x02 \x01(\t\x12\x11\n\tpage_size\x18\x03 \x01(\x05"\xa5\x01\n\x13ListTenantsResponse\x12\x34\n\x07tenants\x18\x01 \x03(\x0b\x32#.google.cloud.talent.v4beta1.Tenant\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12?\n\x08metadata\x18\x03 \x01(\x0b\x32-.google.cloud.talent.v4beta1.ResponseMetadata2\xf0\x06\n\rTenantService\x12\x96\x01\n\x0c\x43reateTenant\x12\x30.google.cloud.talent.v4beta1.CreateTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant"/\x82\xd3\xe4\x93\x02)"$/v4beta1/{parent=projects/*}/tenants:\x01*\x12\x8d\x01\n\tGetTenant\x12-.google.cloud.talent.v4beta1.GetTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant",\x82\xd3\xe4\x93\x02&\x12$/v4beta1/{name=projects/*/tenants/*}\x12\x9d\x01\n\x0cUpdateTenant\x12\x30.google.cloud.talent.v4beta1.UpdateTenantRequest\x1a#.google.cloud.talent.v4beta1.Tenant"6\x82\xd3\xe4\x93\x02\x30\x32+/v4beta1/{tenant.name=projects/*/tenants/*}:\x01*\x12\x86\x01\n\x0c\x44\x65leteTenant\x12\x30.google.cloud.talent.v4beta1.DeleteTenantRequest\x1a\x16.google.protobuf.Empty",\x82\xd3\xe4\x93\x02&*$/v4beta1/{name=projects/*/tenants/*}\x12\x9e\x01\n\x0bListTenants\x12/.google.cloud.talent.v4beta1.ListTenantsRequest\x1a\x30.google.cloud.talent.v4beta1.ListTenantsResponse",\x82\xd3\xe4\x93\x02&\x12$/v4beta1/{parent=projects/*}/tenants\x1al\xca\x41\x13jobs.googleapis.com\xd2\x41Shttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobsB\x80\x01\n\x1f\x63om.google.cloud.talent.v4beta1B\x12TenantServiceProtoP\x01ZAgoogle.golang.org/genproto/googleapis/cloud/talent/v4beta1;talent\xa2\x02\x03\x43TSb\x06proto3' ), dependencies=[ google_dot_api_dot_annotations__pb2.DESCRIPTOR, + google_dot_api_dot_client__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_common__pb2.DESCRIPTOR, google_dot_cloud_dot_talent__v4beta1_dot_proto_dot_tenant__pb2.DESCRIPTOR, google_dot_protobuf_dot_empty__pb2.DESCRIPTOR, @@ -98,8 +100,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=276, - serialized_end=366, + serialized_start=301, + serialized_end=391, ) @@ -137,8 +139,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=368, - serialized_end=400, + serialized_start=393, + serialized_end=425, ) @@ -194,8 +196,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=402, - serialized_end=525, + serialized_start=427, + serialized_end=550, ) @@ -233,8 +235,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=527, - serialized_end=562, + serialized_start=552, + serialized_end=587, ) @@ -308,8 +310,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=564, - serialized_end=639, + serialized_start=589, + serialized_end=664, ) @@ -383,8 +385,8 @@ syntax="proto3", extension_ranges=[], oneofs=[], - serialized_start=642, - serialized_end=807, + serialized_start=667, + serialized_end=832, ) _CREATETENANTREQUEST.fields_by_name[ @@ -423,11 +425,11 @@ Attributes: parent: - Required. Resource name of the project under which the tenant + Required. Resource name of the project under which the tenant is created. The format is "projects/{project\_id}", for example, "projects/api-test-project". tenant: - Required. The tenant to be created. + Required. The tenant to be created. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.CreateTenantRequest) ), @@ -445,7 +447,7 @@ Attributes: name: - Required. The resource name of the tenant to be retrieved. + Required. The resource name of the tenant to be retrieved. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". """, @@ -465,7 +467,7 @@ Attributes: tenant: - Required. The tenant resource to replace the current resource + Required. The tenant resource to replace the current resource in the system. update_mask: Optional but strongly recommended for the best service @@ -493,7 +495,7 @@ Attributes: name: - Required. The resource name of the tenant to be deleted. The + Required. The resource name of the tenant to be deleted. The format is "projects/{project\_id}/tenants/{tenant\_id}", for example, "projects/api-test-project/tenants/foo". """, @@ -513,14 +515,13 @@ Attributes: parent: - Required. Resource name of the project under which the tenant + Required. Resource name of the project under which the tenant is created. The format is "projects/{project\_id}", for example, "projects/api-test-project". page_token: - Optional. The starting indicator from which to return - results. + Optional. The starting indicator from which to return results. page_size: - Optional. The maximum number of tenants to be returned, at + Optional. The maximum number of tenants to be returned, at most 100. Default is 100 if a non-positive number is provided. """, # @@protoc_insertion_point(class_scope:google.cloud.talent.v4beta1.ListTenantsRequest) @@ -561,9 +562,11 @@ full_name="google.cloud.talent.v4beta1.TenantService", file=DESCRIPTOR, index=0, - serialized_options=None, - serialized_start=810, - serialized_end=1580, + serialized_options=_b( + "\312A\023jobs.googleapis.com\322AShttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/jobs" + ), + serialized_start=835, + serialized_end=1715, methods=[ _descriptor.MethodDescriptor( name="CreateTenant", diff --git a/packages/google-cloud-talent/noxfile.py b/packages/google-cloud-talent/noxfile.py index f6257317fccd..a2eefbb6765f 100644 --- a/packages/google-cloud-talent/noxfile.py +++ b/packages/google-cloud-talent/noxfile.py @@ -24,7 +24,7 @@ LOCAL_DEPS = (os.path.join("..", "api_core"), os.path.join("..", "core")) - +BLACK_VERSION = "black==19.3b0" BLACK_PATHS = ["docs", "google", "tests", "noxfile.py", "setup.py"] if os.path.exists("samples"): @@ -38,7 +38,7 @@ def lint(session): Returns a failure if the linters find linting errors or sufficiently serious code quality issues. """ - session.install("flake8", "black", *LOCAL_DEPS) + session.install("flake8", BLACK_VERSION, *LOCAL_DEPS) session.run("black", "--check", *BLACK_PATHS) session.run("flake8", "google", "tests") @@ -53,7 +53,7 @@ def blacken(session): That run uses an image that doesn't have 3.6 installed. Before updating this check the state of the `gcp_ubuntu_config` we use for that Kokoro run. """ - session.install("black") + session.install(BLACK_VERSION) session.run("black", *BLACK_PATHS) diff --git a/packages/google-cloud-talent/synth.metadata b/packages/google-cloud-talent/synth.metadata index 1e6a575a065a..c08954409689 100644 --- a/packages/google-cloud-talent/synth.metadata +++ b/packages/google-cloud-talent/synth.metadata @@ -1,19 +1,19 @@ { - "updateTime": "2019-06-28T12:35:50.825068Z", + "updateTime": "2019-07-03T12:39:55.307403Z", "sources": [ { "generator": { "name": "artman", - "version": "0.29.2", - "dockerImage": "googleapis/artman@sha256:45263333b058a4b3c26a8b7680a2710f43eae3d250f791a6cb66423991dcb2df" + "version": "0.29.3", + "dockerImage": "googleapis/artman@sha256:8900f94a81adaab0238965aa8a7b3648791f4f3a95ee65adc6a56cfcc3753101" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "84c8ad4e52f8eec8f08a60636cfa597b86969b5c", - "internalRef": "255474859" + "sha": "69916b6ffbb7717fa009033351777d0c9909fb79", + "internalRef": "256241904" } }, { diff --git a/packages/google-cloud-talent/tests/unit/gapic/v4beta1/test_profile_service_client_v4beta1.py b/packages/google-cloud-talent/tests/unit/gapic/v4beta1/test_profile_service_client_v4beta1.py index 3455c04c7ba0..7ca0a6d1b829 100644 --- a/packages/google-cloud-talent/tests/unit/gapic/v4beta1/test_profile_service_client_v4beta1.py +++ b/packages/google-cloud-talent/tests/unit/gapic/v4beta1/test_profile_service_client_v4beta1.py @@ -303,11 +303,13 @@ def test_search_profiles(self): # Setup Expected Response estimated_total_size = 1882144769 next_page_token = "" + result_set_id = "resultSetId-770306950" summarized_profiles_element = {} summarized_profiles = [summarized_profiles_element] expected_response = { "estimated_total_size": estimated_total_size, "next_page_token": next_page_token, + "result_set_id": result_set_id, "summarized_profiles": summarized_profiles, } expected_response = profile_service_pb2.SearchProfilesResponse(