Skip to content

KMS: Update docstrings (via synth). #7868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
busunkim96 merged 1 commit into from
May 8, 2019
Merged

KMS: Update docstrings (via synth). #7868

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions kms/google/cloud/kms_v1/gapic/key_management_service_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1858,8 +1858,7 @@ def set_iam_policy(

Args:
resource (str): REQUIRED: The resource for which the policy is being specified.
``resource`` is usually specified as a path. For example, a Project
resource is specified as ``projects/{project}``.
See the operation documentation for the appropriate value for this field.
policy (Union[dict, ~google.cloud.kms_v1.types.Policy]): REQUIRED: The complete policy to be applied to the ``resource``. The
size of the policy is limited to a few 10s of KB. An empty policy is a
valid policy but certain Cloud Platform services (such as Projects)
Expand Down Expand Up @@ -1938,8 +1937,7 @@ def get_iam_policy(

Args:
resource (str): REQUIRED: The resource for which the policy is being requested.
``resource`` is usually specified as a path. For example, a Project
resource is specified as ``projects/{project}``.
See the operation documentation for the appropriate value for this field.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
Expand Down Expand Up @@ -2001,6 +1999,10 @@ def test_iam_permissions(
resource does not exist, this will return an empty set of permissions,
not a NOT\_FOUND error.

Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.

Example:
>>> from google.cloud import kms_v1
>>>
Expand All @@ -2015,8 +2017,7 @@ def test_iam_permissions(

Args:
resource (str): REQUIRED: The resource for which the policy detail is being requested.
``resource`` is usually specified as a path. For example, a Project
resource is specified as ``projects/{project}``.
See the operation documentation for the appropriate value for this field.
permissions (list[str]): The set of permissions to check for the ``resource``. Permissions with
wildcards (such as '*' or 'storage.*') are not allowed. For more
information see `IAM
Expand Down
4 changes: 4 additions & 0 deletions kms/google/cloud/kms_v1/gapic/transports/key_management_service_grpc_transport.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,10 @@ def test_iam_permissions(self):
resource does not exist, this will return an empty set of permissions,
not a NOT\_FOUND error.

Note: This operation is designed to be used for building
permission-aware UIs and command-line tools, not for authorization
checking. This operation may "fail open" without warning.

Returns:
Callable: A callable which accepts the appropriate
deserialized request object and returns a
Expand Down
12 changes: 6 additions & 6 deletions kms/synth.metadata
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"updateTime": "2019-05-01T20:25:40.444411Z",
"updateTime": "2019-05-07T12:19:00.766715Z",
"sources": [
{
"generator": {
"name": "artman",
"version": "0.17.1",
"dockerImage": "googleapis/artman@sha256:a40ca4dd4ef031c0ded4df4909ffdf7b3f20d29b23e682ef991eb60ba0ca6025"
"version": "0.19.0",
"dockerImage": "googleapis/artman@sha256:d3df563538225ac6caac45d8ad86499500211d1bcb2536955a6dbda15e1b368e"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "316b54c401ab9bc08ed71cb362915b9e7a23bb05",
"internalRef": "246014263"
"sha": "5aeb4179d0c424be6b1b228bce7ec75ec24f3d12",
"internalRef": "246901187"
}
},
{
"template": {
"name": "python_library",
"origin": "synthtool.gcp",
"version": "2019.4.24"
"version": "2019.5.2"
}
}
],
Expand Down