Skip to content

Commit 8ef5eca

Browse files
yoshi-automationemar-kar
authored andcommitted
Add filter_ arg to ProfileServiceClient.list_profiles; docstring updates (via synth). (googleapis#9223)
1 parent dce5382 commit 8ef5eca

44 files changed

Lines changed: 2524 additions & 2678 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

talent/google/cloud/talent_v4beta1/gapic/application_service_client.py

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -241,9 +241,8 @@ def create_application(
241241
created.
242242
243243
The format is
244-
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}",
245-
for example,
246-
"projects/test-project/tenants/test-tenant/profiles/test-profile".
244+
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}".
245+
For example, "projects/foo/tenants/bar/profiles/baz".
247246
application (Union[dict, ~google.cloud.talent_v4beta1.types.Application]): Required. The application to be created.
248247
249248
If a dict is provided, it must be of the same form as the protobuf
@@ -321,9 +320,8 @@ def get_application(
321320
name (str): Required. The resource name of the application to be retrieved.
322321
323322
The format is
324-
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}",
325-
for example,
326-
"projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
323+
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}".
324+
For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
327325
retry (Optional[google.api_core.retry.Retry]): A retry object used
328326
to retry requests. If ``None`` is specified, requests will
329327
be retried using a default configuration.
@@ -399,7 +397,7 @@ def update_application(
399397
400398
If a dict is provided, it must be of the same form as the protobuf
401399
message :class:`~google.cloud.talent_v4beta1.types.Application`
402-
update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional but strongly recommended for the best service experience.
400+
update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Strongly recommended for the best service experience.
403401
404402
If ``update_mask`` is provided, only the specified fields in
405403
``application`` are updated. Otherwise all the fields are updated.
@@ -482,9 +480,8 @@ def delete_application(
482480
name (str): Required. The resource name of the application to be deleted.
483481
484482
The format is
485-
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}",
486-
for example,
487-
"projects/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
483+
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}/applications/{application\_id}".
484+
For example, "projects/foo/tenants/bar/profiles/baz/applications/qux".
488485
retry (Optional[google.api_core.retry.Retry]): A retry object used
489486
to retry requests. If ``None`` is specified, requests will
490487
be retried using a default configuration.
@@ -568,8 +565,7 @@ def list_applications(
568565
569566
The format is
570567
"projects/{project\_id}/tenants/{tenant\_id}/profiles/{profile\_id}",
571-
for example,
572-
"projects/test-project/tenants/test-tenant/profiles/test-profile".
568+
for example, "projects/foo/tenants/bar/profiles/baz".
573569
page_size (int): The maximum number of resources contained in the
574570
underlying API response. If page streaming is performed per-
575571
resource, this parameter does not affect the return value. If page

talent/google/cloud/talent_v4beta1/gapic/company_service_client.py

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -249,10 +249,8 @@ def create_company(
249249
created.
250250
251251
The format is "projects/{project\_id}/tenants/{tenant\_id}", for
252-
example, "projects/api-test-project/tenant/foo".
253-
254-
Tenant id is optional and a default tenant is created if unspecified,
255-
for example, "projects/api-test-project".
252+
example, "projects/foo/tenant/bar". If tenant id is unspecified, a
253+
default tenant is created, for example, "projects/foo".
256254
company (Union[dict, ~google.cloud.talent_v4beta1.types.Company]): Required. The company to be created.
257255
258256
If a dict is provided, it must be of the same form as the protobuf
@@ -333,8 +331,8 @@ def get_company(
333331
"projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}",
334332
for example, "projects/api-test-project/tenants/foo/companies/bar".
335333
336-
Tenant id is optional and the default tenant is used if unspecified, for
337-
example, "projects/api-test-project/companies/bar".
334+
If tenant id is unspecified, the default tenant is used, for example,
335+
"projects/api-test-project/companies/bar".
338336
retry (Optional[google.api_core.retry.Retry]): A retry object used
339337
to retry requests. If ``None`` is specified, requests will
340338
be retried using a default configuration.
@@ -410,7 +408,7 @@ def update_company(
410408
411409
If a dict is provided, it must be of the same form as the protobuf
412410
message :class:`~google.cloud.talent_v4beta1.types.Company`
413-
update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Optional but strongly recommended for the best service experience.
411+
update_mask (Union[dict, ~google.cloud.talent_v4beta1.types.FieldMask]): Strongly recommended for the best service experience.
414412
415413
If ``update_mask`` is provided, only the specified fields in ``company``
416414
are updated. Otherwise all the fields are updated.
@@ -495,10 +493,10 @@ def delete_company(
495493
496494
The format is
497495
"projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}",
498-
for example, "projects/api-test-project/tenants/foo/companies/bar".
496+
for example, "projects/foo/tenants/bar/companies/baz".
499497
500-
Tenant id is optional and the default tenant is used if unspecified, for
501-
example, "projects/api-test-project/companies/bar".
498+
If tenant id is unspecified, the default tenant is used, for example,
499+
"projects/foo/companies/bar".
502500
retry (Optional[google.api_core.retry.Retry]): A retry object used
503501
to retry requests. If ``None`` is specified, requests will
504502
be retried using a default configuration.
@@ -582,16 +580,16 @@ def list_companies(
582580
created.
583581
584582
The format is "projects/{project\_id}/tenants/{tenant\_id}", for
585-
example, "projects/api-test-project/tenant/foo".
583+
example, "projects/foo/tenant/bar".
586584
587-
Tenant id is optional and the default tenant is used if unspecified, for
588-
example, "projects/api-test-project".
585+
If tenant id is unspecified, the default tenant will be used, for
586+
example, "projects/foo".
589587
page_size (int): The maximum number of resources contained in the
590588
underlying API response. If page streaming is performed per-
591589
resource, this parameter does not affect the return value. If page
592590
streaming is performed per-page, this determines the maximum number
593591
of resources in a page.
594-
require_open_jobs (bool): Optional. Set to true if the companies requested must have open jobs.
592+
require_open_jobs (bool): Set to true if the companies requested must have open jobs.
595593
596594
Defaults to false.
597595

talent/google/cloud/talent_v4beta1/gapic/completion_client.py

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -257,19 +257,19 @@ def complete_query(
257257
parent (str): Required. Resource name of tenant the completion is performed within.
258258
259259
The format is "projects/{project\_id}/tenants/{tenant\_id}", for
260-
example, "projects/api-test-project/tenant/foo".
260+
example, "projects/foo/tenant/bar".
261261
262-
Tenant id is optional and the default tenant is used if unspecified, for
263-
example, "projects/api-test-project".
262+
If tenant id is unspecified, the default tenant is used, for example,
263+
"projects/foo".
264264
query (str): Required. The query used to generate suggestions.
265265
266266
The maximum number of allowed characters is 255.
267267
page_size (int): Required. Completion result count.
268268
269269
The maximum allowed page size is 10.
270-
language_codes (list[str]): Optional. The list of languages of the query. This is the BCP-47
271-
language code, such as "en-US" or "sr-Latn". For more information, see
272-
`Tags for Identifying Languages <https://tools.ietf.org/html/bcp47>`__.
270+
language_codes (list[str]): The list of languages of the query. This is the BCP-47 language code,
271+
such as "en-US" or "sr-Latn". For more information, see `Tags for
272+
Identifying Languages <https://tools.ietf.org/html/bcp47>`__.
273273
274274
For ``CompletionType.JOB_TITLE`` type, only open jobs with the same
275275
``language_codes`` are returned.
@@ -282,18 +282,16 @@ def complete_query(
282282
``language_codes`` are returned.
283283
284284
The maximum number of allowed characters is 255.
285-
company (str): Optional. If provided, restricts completion to specified company.
285+
company (str): If provided, restricts completion to specified company.
286286
287287
The format is
288288
"projects/{project\_id}/tenants/{tenant\_id}/companies/{company\_id}",
289-
for example, "projects/api-test-project/tenants/foo/companies/bar".
290-
291-
Tenant id is optional and the default tenant is used if unspecified, for
292-
example, "projects/api-test-project/companies/bar".
293-
scope (~google.cloud.talent_v4beta1.types.CompletionScope): Optional. The scope of the completion. The defaults is
294-
``CompletionScope.PUBLIC``.
295-
type_ (~google.cloud.talent_v4beta1.types.CompletionType): Optional. The completion topic. The default is
296-
``CompletionType.COMBINED``.
289+
for example, "projects/foo/tenants/bar/companies/baz".
290+
291+
If tenant id is unspecified, the default tenant is used, for example,
292+
"projects/foo".
293+
scope (~google.cloud.talent_v4beta1.types.CompletionScope): The scope of the completion. The defaults is ``CompletionScope.PUBLIC``.
294+
type_ (~google.cloud.talent_v4beta1.types.CompletionType): The completion topic. The default is ``CompletionType.COMBINED``.
297295
retry (Optional[google.api_core.retry.Retry]): A retry object used
298296
to retry requests. If ``None`` is specified, requests will
299297
be retried using a default configuration.

talent/google/cloud/talent_v4beta1/gapic/enums.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,6 @@ class EmploymentType(enum.IntEnum):
179179

180180
class HtmlSanitization(enum.IntEnum):
181181
"""
182-
Input only.
183-
184182
Option for HTML content sanitization on user input fields, for example, job
185183
description. By setting this option, user can determine whether and how
186184
sanitization is performed on these fields.
@@ -999,7 +997,8 @@ class SearchMode(enum.IntEnum):
999997
operate differently for different modes of service.
1000998
1001999
Attributes:
1002-
SEARCH_MODE_UNSPECIFIED (int): The mode of the search method isn't specified.
1000+
SEARCH_MODE_UNSPECIFIED (int): The mode of the search method isn't specified. The default search
1001+
behavior is identical to JOB\_SEARCH search behavior.
10031002
JOB_SEARCH (int): The job search matches against all jobs, and featured jobs
10041003
(jobs with promotionValue > 0) are not specially handled.
10051004
FEATURED_JOB_SEARCH (int): The job search matches only against featured jobs (jobs with a

talent/google/cloud/talent_v4beta1/gapic/event_service_client.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -240,10 +240,8 @@ def create_client_event(
240240
parent (str): Required. Resource name of the tenant under which the event is created.
241241
242242
The format is "projects/{project\_id}/tenants/{tenant\_id}", for
243-
example, "projects/api-test-project/tenant/foo".
244-
245-
Tenant id is optional and a default tenant is created if unspecified,
246-
for example, "projects/api-test-project".
243+
example, "projects/foo/tenant/bar". If tenant id is unspecified, a
244+
default tenant is created, for example, "projects/foo".
247245
client_event (Union[dict, ~google.cloud.talent_v4beta1.types.ClientEvent]): Required. Events issued when end user interacts with customer's application
248246
that uses Cloud Talent Solution.
249247

0 commit comments

Comments
 (0)