Skip to content

Commit 65f1657

Browse files
yoshi-automationtswast
authored andcommitted
Update docstrings (via synth). (#8299)
1 parent dccc582 commit 65f1657

8 files changed

Lines changed: 67 additions & 23 deletions

File tree

datacatalog/google/cloud/datacatalog_v1beta1/gapic/data_catalog_client.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,8 +254,14 @@ def search_catalog(
254254
return the complete resource, only the resource identifier and high
255255
level fields. Clients can subsequentally call Get methods.
256256
257+
Note that searches do not have full recall. There may be results that
258+
match your query but are not returned, even in subsequent pages of
259+
results. These missing results may vary across repeated calls to search.
260+
Do not rely on this method if you need to guarantee full recall.
261+
257262
See `Data Catalog Search
258263
Syntax <https://cloud.google.com/data-catalog/docs/how-to/search-reference>`__
264+
for more information.
259265
260266
Example:
261267
>>> from google.cloud import datacatalog_v1beta1
@@ -315,8 +321,7 @@ def search_catalog(
315321
<li> last_access_timestamp [asc|desc], defaults to descending if not
316322
specified, </li>
317323
<li> last_modified_timestamp [asc|desc], defaults to descending if not
318-
specified, </li>
319-
<li> title [asc|desc], defaults to ascending if not specified. </li>
324+
specified. </li>
320325
</ul>
321326
retry (Optional[google.api_core.retry.Retry]): A retry object used
322327
to retry requests. If ``None`` is specified, requests will not
@@ -645,7 +650,9 @@ def create_tag_template(
645650
646651
Args:
647652
parent (str): Required. The name of the project and the location this template is in.
648-
Example: "projects/{project\_id}/locations/{location}".
653+
Example: "projects/{project\_id}/locations/{location}". Note that this
654+
TagTemplate and its child resources may not actually be stored in the
655+
location in this name.
649656
tag_template_id (str): Required. The id of the tag template to create.
650657
tag_template (Union[dict, ~google.cloud.datacatalog_v1beta1.types.TagTemplate]): Required. The tag template to create.
651658
@@ -965,6 +972,8 @@ def create_tag_template_field(
965972
Args:
966973
parent (str): Required. The name of the project this template is in. Example:
967974
"projects/{project\_id}/locations/{location}/tagTemplates/{tag\_template\_id}".
975+
Note that this TagTemplateField may not actually be stored in the
976+
location in this name.
968977
tag_template_field_id (str): Required. The id of the tag template field to create. Field ids can
969978
contain letters (both uppercase and lowercase), numbers (0-9),
970979
underscores (\_) and dashes (-). Field ids must be at least 1 character
@@ -1302,6 +1311,8 @@ def create_tag(
13021311
parent (str): Required. The name of the resource to attach this tag to. Tags can be
13031312
attached to Entries. (example:
13041313
"projects/{project\_id}/locations/{location}/entryGroups/{entry\_group\_id}/entries/{entry\_id}").
1314+
Note that this Tag and its child resources may not actually be stored in
1315+
the location in this name.
13051316
tag (Union[dict, ~google.cloud.datacatalog_v1beta1.types.Tag]): Required. The tag to create.
13061317
13071318
If a dict is provided, it must be of the same form as the protobuf

datacatalog/google/cloud/datacatalog_v1beta1/gapic/transports/data_catalog_grpc_transport.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,14 @@ def search_catalog(self):
108108
return the complete resource, only the resource identifier and high
109109
level fields. Clients can subsequentally call Get methods.
110110
111+
Note that searches do not have full recall. There may be results that
112+
match your query but are not returned, even in subsequent pages of
113+
results. These missing results may vary across repeated calls to search.
114+
Do not rely on this method if you need to guarantee full recall.
115+
111116
See `Data Catalog Search
112117
Syntax <https://cloud.google.com/data-catalog/docs/how-to/search-reference>`__
118+
for more information.
113119
114120
Returns:
115121
Callable: A callable which accepts the appropriate

datacatalog/google/cloud/datacatalog_v1beta1/proto/datacatalog.proto

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,13 @@ service DataCatalog {
4848
// the complete resource, only the resource identifier and high level
4949
// fields. Clients can subsequentally call Get methods.
5050
//
51+
// Note that searches do not have full recall. There may be results that match
52+
// your query but are not returned, even in subsequent pages of results. These
53+
// missing results may vary across repeated calls to search. Do not rely on
54+
// this method if you need to guarantee full recall.
55+
//
5156
// See [Data Catalog Search
52-
// Syntax](/data-catalog/docs/how-to/search-reference)
57+
// Syntax](/data-catalog/docs/how-to/search-reference) for more information.
5358
rpc SearchCatalog(SearchCatalogRequest) returns (SearchCatalogResponse) {
5459
option (google.api.http) = {
5560
post: "/v1beta1/catalog:search"
@@ -294,8 +299,7 @@ message SearchCatalogRequest {
294299
// <li> last_access_timestamp [asc|desc], defaults to descending if not
295300
// specified, </li>
296301
// <li> last_modified_timestamp [asc|desc], defaults to descending if not
297-
// specified, </li>
298-
// <li> title [asc|desc], defaults to ascending if not specified. </li>
302+
// specified. </li>
299303
// </ul>
300304
string order_by = 5;
301305
}
@@ -384,6 +388,8 @@ message Entry {
384388
// [UpdateEntryRequest][google.cloud.datacatalog.v1beta1.UpdateEntryRequest].
385389
// The Data Catalog resource name of the entry in URL format. For example,
386390
// "projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}".
391+
// Note that this Entry and its child resources may not actually be stored in
392+
// the location in this name.
387393
string name = 1;
388394

389395
// Output only. The full name of the cloud resource the entry belongs to. See:
@@ -433,7 +439,9 @@ message Entry {
433439
// [CreateTagTemplate][google.cloud.datacatalog.v1beta1.DataCatalog.CreateTagTemplate].
434440
message CreateTagTemplateRequest {
435441
// Required. The name of the project and the location this template is in.
436-
// Example: "projects/{project_id}/locations/{location}".
442+
// Example: "projects/{project_id}/locations/{location}". Note that this
443+
// TagTemplate and its child resources may not actually be stored in the
444+
// location in this name.
437445
string parent = 1;
438446

439447
// Required. The id of the tag template to create.
@@ -487,6 +495,8 @@ message CreateTagRequest {
487495
// The name of the resource to attach this tag to. Tags can be attached to
488496
// Entries. (example:
489497
// "projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}").
498+
// Note that this Tag and its child resources may not actually be stored in
499+
// the location in this name.
490500
string parent = 1;
491501

492502
// Required. The tag to create.
@@ -518,6 +528,8 @@ message DeleteTagRequest {
518528
message CreateTagTemplateFieldRequest {
519529
// Required. The name of the project this template is in. Example:
520530
// "projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}".
531+
// Note that this TagTemplateField may not actually be stored in the location
532+
// in this name.
521533
string parent = 1;
522534

523535
// Required. The id of the tag template field to create.

datacatalog/google/cloud/datacatalog_v1beta1/proto/datacatalog_pb2.py

Lines changed: 12 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

datacatalog/google/cloud/datacatalog_v1beta1/proto/datacatalog_pb2_grpc.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,13 @@ def SearchCatalog(self, request, context):
134134
the complete resource, only the resource identifier and high level
135135
fields. Clients can subsequentally call Get methods.
136136
137+
Note that searches do not have full recall. There may be results that match
138+
your query but are not returned, even in subsequent pages of results. These
139+
missing results may vary across repeated calls to search. Do not rely on
140+
this method if you need to guarantee full recall.
141+
137142
See [Data Catalog Search
138-
Syntax](/data-catalog/docs/how-to/search-reference)
143+
Syntax](/data-catalog/docs/how-to/search-reference) for more information.
139144
"""
140145
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
141146
context.set_details("Method not implemented!")

datacatalog/google/cloud/datacatalog_v1beta1/proto/tags.proto

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ message Tag {
3131
// [UpdateTagRequest][google.cloud.datacatalog.v1beta1.UpdateTagRequest]. The
3232
// resource name of the tag in URL format. For example,
3333
// projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}",
34-
// where tag_id is a system-generated identifier.
34+
// where tag_id is a system-generated identifier. Note that this Tag may not
35+
// actually be stored in the location in this name.
3536
string name = 1;
3637

3738
// Required. The resource name of the tag template that this tag uses. For
@@ -102,6 +103,8 @@ message TagTemplate {
102103
// [UpdateTagTemplateRequest][google.cloud.datacatalog.v1beta1.UpdateTagTemplateRequest].
103104
// The resource name of the tag template in URL format. For example,
104105
// projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}.
106+
// Note that this TagTemplate and its child resources may not actually be
107+
// stored in the location in this name.
105108
string name = 1;
106109

107110
// Optional. The display name for this template. Default value is an empty

datacatalog/google/cloud/datacatalog_v1beta1/proto/tags_pb2.py

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

datacatalog/synth.metadata

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"updateTime": "2019-06-10T17:48:19.192741Z",
2+
"updateTime": "2019-06-13T12:14:41.123707Z",
33
"sources": [
44
{
55
"generator": {
66
"name": "artman",
7-
"version": "0.24.0",
8-
"dockerImage": "googleapis/artman@sha256:ce425884865f57f18307e597bca1a74a3619b7098688d4995261f3ffb3488681"
7+
"version": "0.24.1",
8+
"dockerImage": "googleapis/artman@sha256:6018498e15310260dc9b03c9d576608908ed9fbabe42e1494ff3d827fea27b19"
99
}
1010
},
1111
{
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "a12347ec47a7f3d18e35f2effc4295c0b0983213",
16-
"internalRef": "252108410"
15+
"sha": "46bfd341116c385fd1671675f918da7d513b20c4",
16+
"internalRef": "252913906"
1717
}
1818
},
1919
{

0 commit comments

Comments
 (0)