Add filter_ arg to ProfileServiceClient.list_profiles; docstring …

…updates (via synth). (#9223)
googleapis · Sep 13, 2019 · a616b85 · a616b85
1 parent 88becff
commit a616b85
Show file tree

Hide file tree

Showing 44 changed files with 2,524 additions and 2,678 deletions.
diff --git a/talent/google/cloud/talent_v4beta1/gapic/application_service_client.py b/talent/google/cloud/talent_v4beta1/gapic/application_service_client.py
@@ -241,9 +241,8 @@ def create_application(
                 created.
 
                 The format is
-                "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}",
-                for example,
-                "projects/test-project/tenants/test-tenant/profiles/test-profile".
+                "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}".
+                For example, "projects/foo/tenants/bar/profiles/baz".
             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
@@ -321,9 +320,8 @@ def get_application(
             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}",
-                for example,
-                "projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
+                "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}".
+                For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
             retry (Optional[google.api_core.retry.Retry]):  A retry object used
                 to retry requests. If ``None`` is specified, requests will
                 be retried using a default configuration.
@@ -399,7 +397,7 @@ def update_application(
 
                 If a dict is provided, it must be of the same form as the protobuf
                 message :class:`~google.cloud.talent_v4beta1.types.Application`
-            update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional but strongly recommended for the best service experience.
+            update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Strongly recommended for the best service experience.
 
                 If ``update_mask`` is provided, only the specified fields in
                 ``application`` are updated. Otherwise all the fields are updated.
@@ -482,9 +480,8 @@ def delete_application(
             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}",
-                for example,
-                "projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
+                "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}".
+                For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
             retry (Optional[google.api_core.retry.Retry]):  A retry object used
                 to retry requests. If ``None`` is specified, requests will
                 be retried using a default configuration.
@@ -568,8 +565,7 @@ def list_applications(
 
                 The format is
                 "projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}",
-                for example,
-                "projects/test-project/tenants/test-tenant/profiles/test-profile".
+                for example, "projects/foo/tenants/bar/profiles/baz".
             page_size (int): The maximum number of resources contained in the
                 underlying API response. If page streaming is performed per-
                 resource, this parameter does not affect the return value. If page

diff --git a/talent/google/cloud/talent_v4beta1/gapic/company_service_client.py b/talent/google/cloud/talent_v4beta1/gapic/company_service_client.py
@@ -249,10 +249,8 @@ def create_company(
                 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".
+                example, "projects/foo/tenant/bar". If tenant id is unspecified, a
+                default tenant is created, for example, "projects/foo".
             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
@@ -333,8 +331,8 @@ def get_company(
                 "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".
+                If tenant id is unspecified, the default tenant is used, for example,
+                "projects/api-test-project/companies/bar".
             retry (Optional[google.api_core.retry.Retry]):  A retry object used
                 to retry requests. If ``None`` is specified, requests will
                 be retried using a default configuration.
@@ -410,7 +408,7 @@ def update_company(
 
                 If a dict is provided, it must be of the same form as the protobuf
                 message :class:`~google.cloud.talent_v4beta1.types.Company`
-            update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional but strongly recommended for the best service experience.
+            update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Strongly recommended for the best service experience.
 
                 If ``update_mask`` is provided, only the specified fields in ``company``
                 are updated. Otherwise all the fields are updated.
@@ -495,10 +493,10 @@ def delete_company(
 
                 The format is
                 "projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}",
-                for example, "projects/api-test-project/tenants/foo/companies/bar".
+                for example, "projects/foo/tenants/bar/companies/baz".
 
-                Tenant id is optional and the default tenant is used if unspecified, for
-                example, "projects/api-test-project/companies/bar".
+                If tenant id is unspecified, the default tenant is used, for example,
+                "projects/foo/companies/bar".
             retry (Optional[google.api_core.retry.Retry]):  A retry object used
                 to retry requests. If ``None`` is specified, requests will
                 be retried using a default configuration.
@@ -582,16 +580,16 @@ def list_companies(
                 created.
 
                 The format is "projects/{project\_id}/tenants/{tenant\_id}", for
-                example, "projects/api-test-project/tenant/foo".
+                example, "projects/foo/tenant/bar".
 
-                Tenant id is optional and the default tenant is used if unspecified, for
-                example, "projects/api-test-project".
+                If tenant id is unspecified, the default tenant will be used, for
+                example, "projects/foo".
             page_size (int): The maximum number of resources contained in the
                 underlying API response. If page streaming is performed per-
                 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): Set to true if the companies requested must have open jobs.
 
                 Defaults to false.
 

diff --git a/talent/google/cloud/talent_v4beta1/gapic/completion_client.py b/talent/google/cloud/talent_v4beta1/gapic/completion_client.py
@@ -257,19 +257,19 @@ def complete_query(
             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".
+                example, "projects/foo/tenant/bar".
 
-                Tenant id is optional and the default tenant is used if unspecified, for
-                example, "projects/api-test-project".
+                If tenant id is unspecified, the default tenant is used, for example,
+                "projects/foo".
             query (str): Required. The query used to generate suggestions.
 
                 The maximum number of allowed characters is 255.
             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 <https://tools.ietf.org/html/bcp47>`__.
+            language_codes (list[str]): 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>`__.
 
                 For ``CompletionType.JOB_TITLE`` type, only open jobs with the same
                 ``language_codes`` are returned.
@@ -282,18 +282,16 @@ 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): If provided, restricts completion to specified company.
 
                 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".
-            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``.
+                for example, "projects/foo/tenants/bar/companies/baz".
+
+                If tenant id is unspecified, the default tenant is used, for example,
+                "projects/foo".
+            scope (~google.cloud.talent_v4beta1.types.CompletionScope): The scope of the completion. The defaults is ``CompletionScope.PUBLIC``.
+            type_ (~google.cloud.talent_v4beta1.types.CompletionType): 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
                 be retried using a default configuration.

diff --git a/talent/google/cloud/talent_v4beta1/gapic/enums.py b/talent/google/cloud/talent_v4beta1/gapic/enums.py
@@ -179,8 +179,6 @@ class EmploymentType(enum.IntEnum):
 
 class HtmlSanitization(enum.IntEnum):
     """
-    Input only.
-
     Option for HTML content sanitization on user input fields, for example, job
     description. By setting this option, user can determine whether and how
     sanitization is performed on these fields.
@@ -999,7 +997,8 @@ class SearchMode(enum.IntEnum):
         operate differently for different modes of service.
 
         Attributes:
-          SEARCH_MODE_UNSPECIFIED (int): The mode of the search method isn't specified.
+          SEARCH_MODE_UNSPECIFIED (int): The mode of the search method isn't specified. The default search
+          behavior is identical to JOB\_SEARCH search behavior.
           JOB_SEARCH (int): The job search matches against all jobs, and featured jobs
           (jobs with promotionValue > 0) are not specially handled.
           FEATURED_JOB_SEARCH (int): The job search matches only against featured jobs (jobs with a

diff --git a/talent/google/cloud/talent_v4beta1/gapic/event_service_client.py b/talent/google/cloud/talent_v4beta1/gapic/event_service_client.py
@@ -240,10 +240,8 @@ def create_client_event(
             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".
+                example, "projects/foo/tenant/bar". If tenant id is unspecified, a
+                default tenant is created, for example, "projects/foo".
             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.