docs: update generated docs (#981)
diff --git a/docs/dyn/iam_v1.roles.html b/docs/dyn/iam_v1.roles.html
index 6ab1358..8b855e2 100644
--- a/docs/dyn/iam_v1.roles.html
+++ b/docs/dyn/iam_v1.roles.html
@@ -76,23 +76,23 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a Role definition.</p>
+<p class="firstline">Gets the definition of a Role.</p>
<p class="toc_element">
- <code><a href="#list">list(showDeleted=None, pageToken=None, pageSize=None, view=None, parent=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the Roles defined on a resource.</p>
+ <code><a href="#list">list(showDeleted=None, parent=None, view=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists every predefined Role that IAM supports, or every custom role</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Queries roles that can be granted on a particular resource.</p>
+<p class="firstline">Lists roles that can be granted on a Google Cloud resource. A role is</p>
<p class="toc_element">
<code><a href="#queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a Role definition.
+ <pre>Gets the definition of a Role.
Args:
name: string, The `name` parameter's value depends on the target resource for the
@@ -131,40 +131,35 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A String", # The name of the role.
+ #
+ # When Role is used in CreateRole, the role name must not be set.
+ #
+ # When Role is used in output and other input such as UpdateRole, the role
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
+ # selected for a role, the `stage` field will not be included in the
+ # returned definition for the role.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(showDeleted=None, pageToken=None, pageSize=None, view=None, parent=None, x__xgafv=None)</code>
- <pre>Lists the Roles defined on a resource.
+ <code class="details" id="list">list(showDeleted=None, parent=None, view=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <pre>Lists every predefined Role that IAM supports, or every custom role
+that is defined for an organization or project.
Args:
showDeleted: boolean, Include Roles that have been deleted.
- pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
- pageSize: integer, Optional limit on the number of roles to include in the response.
- view: string, Optional view for the returned Role objects. When `FULL` is specified,
-the `includedPermissions` field is returned, which includes a list of all
-permissions in the role. The default value is `BASIC`, which does not
-return the `includedPermissions` field.
parent: string, The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](/iam/reference/rest/v1/roles),
@@ -192,6 +187,14 @@
Note: Wildcard (*) values are invalid; you must specify a complete project
ID or organization ID.
+ view: string, Optional view for the returned Role objects. When `FULL` is specified,
+the `includedPermissions` field is returned, which includes a list of all
+permissions in the role. The default value is `BASIC`, which does not
+return the `includedPermissions` field.
+ pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
+ pageSize: integer, Optional limit on the number of roles to include in the response.
+
+The default is 300, and the maximum is 1,000.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -201,31 +204,31 @@
An object of the form:
{ # The response containing the roles defined under a resource.
- "roles": [ # The Roles defined on this resource.
- { # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- },
- ],
"nextPageToken": "A String", # To retrieve the next page of results, set
# `ListRolesRequest.page_token` to this value.
+ "roles": [ # The Roles defined on this resource.
+ { # A role in the Identity and Access Management API.
+ "name": "A String", # The name of the role.
+ #
+ # When Role is used in CreateRole, the role name must not be set.
+ #
+ # When Role is used in output and other input such as UpdateRole, the role
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
+ # selected for a role, the `stage` field will not be included in the
+ # returned definition for the role.
+ },
+ ],
}</pre>
</div>
@@ -245,24 +248,26 @@
<div class="method">
<code class="details" id="queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</code>
- <pre>Queries roles that can be granted on a particular resource.
-A role is grantable if it can be used as the role in a binding for a policy
-for that resource.
+ <pre>Lists roles that can be granted on a Google Cloud resource. A role is
+grantable if the IAM policy for the resource can contain bindings to the
+role.
Args:
body: object, The request body.
The object takes the form of:
{ # The grantable role query request.
+ "pageToken": "A String", # Optional pagination token returned in an earlier
+ # QueryGrantableRolesResponse.
+ "view": "A String",
+ "pageSize": 42, # Optional limit on the number of roles to include in the response.
+ #
+ # The default is 300, and the maximum is 1,000.
"fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
#
# The name follows the Google Cloud Platform resource format.
# For example, a Cloud Platform project with id `my-project` will be named
# `//cloudresourcemanager.googleapis.com/projects/my-project`.
- "pageToken": "A String", # Optional pagination token returned in an earlier
- # QueryGrantableRolesResponse.
- "pageSize": 42, # Optional limit on the number of roles to include in the response.
- "view": "A String",
}
x__xgafv: string, V1 error format.
@@ -276,26 +281,26 @@
{ # The grantable role query response.
"roles": [ # The list of matching roles.
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
- # selected for a role, the `stage` field will not be included in the
- # returned definition for the role.
- "name": "A String", # The name of the role.
- #
- # When Role is used in CreateRole, the role name must not be set.
- #
- # When Role is used in output and other input such as UpdateRole, the role
- # name is the complete path, e.g., roles/logging.viewer for predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- },
+ "name": "A String", # The name of the role.
+ #
+ # When Role is used in CreateRole, the role name must not be set.
+ #
+ # When Role is used in output and other input such as UpdateRole, the role
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
+ # selected for a role, the `stage` field will not be included in the
+ # returned definition for the role.
+ },
],
"nextPageToken": "A String", # To retrieve the next page of results, set
# `QueryGrantableRolesRequest.page_token` to this value.