52
52
53
53
class PolicyTagManagerClient (object ):
54
54
"""
55
- Policy tag manager API service allows clients to manage their taxonomies and
56
- policy tags data .
55
+ The policy tag manager API service allows clients to manage their taxonomies
56
+ and policy tags.
57
57
"""
58
58
59
59
SERVICE_ADDRESS = "datacatalog.googleapis.com:443"
@@ -205,7 +205,7 @@ def create_taxonomy(
205
205
metadata = None ,
206
206
):
207
207
"""
208
- Creates a new taxonomy in a given project.
208
+ Creates a taxonomy in the specified project.
209
209
210
210
Example:
211
211
>>> from google.cloud import datacatalog_v1beta1
@@ -215,10 +215,8 @@ def create_taxonomy(
215
215
>>> response = client.create_taxonomy()
216
216
217
217
Args:
218
- parent (str): Required. Resource name of the project that the newly created taxonomy
219
- belongs to.
220
- taxonomy (Union[dict, ~google.cloud.datacatalog_v1beta1.types.Taxonomy]): The taxonomy to be created. The name field must be left blank. The
221
- display\_name field is mandatory.
218
+ parent (str): Required. Resource name of the project that the taxonomy will belong to.
219
+ taxonomy (Union[dict, ~google.cloud.datacatalog_v1beta1.types.Taxonomy]): The taxonomy to be created.
222
220
223
221
If a dict is provided, it must be of the same form as the protobuf
224
222
message :class:`~google.cloud.datacatalog_v1beta1.types.Taxonomy`
@@ -281,7 +279,7 @@ def delete_taxonomy(
281
279
):
282
280
"""
283
281
Deletes a taxonomy. This operation will also delete all
284
- policy tags in this taxonomy.
282
+ policy tags in this taxonomy along with their associated policies .
285
283
286
284
Example:
287
285
>>> from google.cloud import datacatalog_v1beta1
@@ -429,7 +427,8 @@ def list_taxonomies(
429
427
metadata = None ,
430
428
):
431
429
"""
432
- Lists all taxonomies in a project in a particular location.
430
+ Lists all taxonomies in a project in a particular location that the caller
431
+ has permission to view.
433
432
434
433
Example:
435
434
>>> from google.cloud import datacatalog_v1beta1
@@ -439,8 +438,9 @@ def list_taxonomies(
439
438
>>> response = client.list_taxonomies()
440
439
441
440
Args:
442
- parent (str): Required. Resource name of a project to list the taxonomies of.
443
- page_size (int): The maximum number of items to return. If not set, defaults to 50.
441
+ parent (str): Required. Resource name of the project to list the taxonomies of.
442
+ page_size (int): The maximum number of items to return. Must be a value between 1 and 1000.
443
+ If not set, defaults to 50.
444
444
page_token (str): The next\_page\_token value returned from a previous list request, if
445
445
any. If not set, defaults to an empty string.
446
446
retry (Optional[google.api_core.retry.Retry]): A retry object used
@@ -511,7 +511,7 @@ def get_taxonomy(
511
511
>>> response = client.get_taxonomy()
512
512
513
513
Args:
514
- name (str): Required. Resource name of the taxonomy to be returned .
514
+ name (str): Required. Resource name of the requested taxonomy .
515
515
retry (Optional[google.api_core.retry.Retry]): A retry object used
516
516
to retry requests. If ``None`` is specified, requests will
517
517
be retried using a default configuration.
@@ -569,7 +569,7 @@ def create_policy_tag(
569
569
metadata = None ,
570
570
):
571
571
"""
572
- Creates a policy tag in a taxonomy.
572
+ Creates a policy tag in the specified taxonomy.
573
573
574
574
Example:
575
575
>>> from google.cloud import datacatalog_v1beta1
@@ -579,11 +579,8 @@ def create_policy_tag(
579
579
>>> response = client.create_policy_tag()
580
580
581
581
Args:
582
- parent (str): Required. Resource name of the taxonomy that the newly created policy tag
583
- belongs to.
584
- policy_tag (Union[dict, ~google.cloud.datacatalog_v1beta1.types.PolicyTag]): The policy tag to be created. The name, and taxonomy\_display\_name
585
- field must be left blank. The display\_name field is mandatory and must
586
- not be duplicated with existing policy tags in the same taxonomy.
582
+ parent (str): Required. Resource name of the taxonomy that the policy tag will belong to.
583
+ policy_tag (Union[dict, ~google.cloud.datacatalog_v1beta1.types.PolicyTag]): The policy tag to be created.
587
584
588
585
If a dict is provided, it must be of the same form as the protobuf
589
586
message :class:`~google.cloud.datacatalog_v1beta1.types.PolicyTag`
@@ -655,7 +652,7 @@ def delete_policy_tag(
655
652
>>> client.delete_policy_tag()
656
653
657
654
Args:
658
- name (str): Required. Resource name of the policy tag to be deleted. All its descendant
655
+ name (str): Required. Resource name of the policy tag to be deleted. All of its descendant
659
656
policy tags will also be deleted.
660
657
retry (Optional[google.api_core.retry.Retry]): A retry object used
661
658
to retry requests. If ``None`` is specified, requests will
@@ -806,8 +803,9 @@ def list_policy_tags(
806
803
>>> response = client.list_policy_tags()
807
804
808
805
Args:
809
- parent (str): Required. Resource name of a taxonomy to list the policy tags of.
810
- page_size (int): The maximum number of items to return. If not set, defaults to 50.
806
+ parent (str): Required. Resource name of the taxonomy to list the policy tags of.
807
+ page_size (int): The maximum number of items to return. Must be a value between 1 and 1000.
808
+ If not set, defaults to 50.
811
809
page_token (str): The next\_page\_token value returned from a previous List request, if
812
810
any. If not set, defaults to an empty string.
813
811
retry (Optional[google.api_core.retry.Retry]): A retry object used
@@ -878,7 +876,7 @@ def get_policy_tag(
878
876
>>> response = client.get_policy_tag()
879
877
880
878
Args:
881
- name (str): Required. Resource name of the policy tag to be returned .
879
+ name (str): Required. Resource name of the requested policy tag.
882
880
retry (Optional[google.api_core.retry.Retry]): A retry object used
883
881
to retry requests. If ``None`` is specified, requests will
884
882
be retried using a default configuration.
@@ -1088,7 +1086,8 @@ def test_iam_permissions(
1088
1086
metadata = None ,
1089
1087
):
1090
1088
"""
1091
- Returns permissions that a caller has on specified resources.
1089
+ Returns the permissions that a caller has on the specified taxonomy or
1090
+ policy tag.
1092
1091
1093
1092
Example:
1094
1093
>>> from google.cloud import datacatalog_v1beta1
0 commit comments