docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index fc43338..1ac0cf8 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Role definition.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
+ <code><a href="#list">list(parent, showDeleted=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the Roles defined on a resource.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -101,11 +101,11 @@
<pre>Creates a new Role.
Args:
- parent: string, The `parent` parameter's value depends on the target resource for the
+ parent: string, The `parent` parameter's value depends on the target resource for the
request, namely
[`projects`](/iam/reference/rest/v1/projects.roles) or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `parent` value format is described below:
+resource type's `parent` value format is described below:
* [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create):
`projects/{PROJECT_ID}`. This method creates project-level
@@ -125,27 +125,27 @@
The object takes the form of:
{ # The request to create a new role.
- "roleId": "A String", # The role ID to use for this role.
- "role": { # A role in the Identity and Access Management API. # The Role resource to create.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of the role.
+ "roleId": "A String", # The role ID to use for this role.
+ "role": { # A role in the Identity and Access Management API. # The Role resource to create.
+ "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.
+ "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.
},
}
@@ -158,25 +158,25 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}</pre>
</div>
@@ -191,11 +191,11 @@
with the role are removed.
Args:
- name: string, The `name` parameter's value depends on the target resource for the
+ name: string, The `name` parameter's value depends on the target resource for the
request, namely
[`projects`](/iam/reference/rest/v1/projects.roles) or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `name` value format is described below:
+resource type's `name` value format is described below:
* [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only
@@ -221,25 +221,25 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}</pre>
</div>
@@ -248,12 +248,12 @@
<pre>Gets a Role definition.
Args:
- name: string, The `name` parameter's value depends on the target resource for the
+ name: string, The `name` parameter's value depends on the target resource for the
request, namely
[`roles`](/iam/reference/rest/v1/roles),
[`projects`](/iam/reference/rest/v1/projects.roles), or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `name` value format is described below:
+resource type's `name` value format is described below:
* [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
This method returns results from all
@@ -284,42 +284,42 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</code>
+ <code class="details" id="list">list(parent, showDeleted=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Lists the Roles defined on a resource.
Args:
- parent: string, The `parent` parameter's value depends on the target resource for the
+ parent: string, The `parent` parameter's value depends on the target resource for the
request, namely
[`roles`](/iam/reference/rest/v1/roles),
[`projects`](/iam/reference/rest/v1/projects.roles), or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `parent` value format is described below:
+resource type's `parent` value format is described below:
* [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
- This method doesn't require a resource; it simply returns all
+ This method doesn't require a resource; it simply returns all
[predefined roles](/iam/docs/understanding-roles#predefined_roles) in
Cloud IAM. Example request URL:
`https://iam.googleapis.com/v1/roles`
@@ -338,47 +338,47 @@
Note: Wildcard (*) values are invalid; you must specify a complete project
ID or organization ID. (required)
- pageSize: integer, Optional limit on the number of roles to include in the response.
showDeleted: boolean, Include Roles that have been deleted.
pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
+ 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.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
{ # The response containing the roles defined under a resource.
- "nextPageToken": "A String", # To retrieve the next page of results, set
- # `ListRolesRequest.page_token` to this value.
- "roles": [ # The Roles defined on this resource.
+ "roles": [ # The Roles defined on this resource.
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
},
],
+ "nextPageToken": "A String", # To retrieve the next page of results, set
+ # `ListRolesRequest.page_token` to this value.
}</pre>
</div>
@@ -391,7 +391,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -401,11 +401,11 @@
<pre>Updates a Role definition.
Args:
- name: string, The `name` parameter's value depends on the target resource for the
+ name: string, The `name` parameter's value depends on the target resource for the
request, namely
[`projects`](/iam/reference/rest/v1/projects.roles) or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `name` value format is described below:
+resource type's `name` value format is described below:
* [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only
@@ -425,25 +425,25 @@
The object takes the form of:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}
updateMask: string, A mask describing which fields in the Role have changed.
@@ -456,25 +456,25 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}</pre>
</div>
@@ -483,11 +483,11 @@
<pre>Undelete a Role, bringing it back in its previous state.
Args:
- name: string, The `name` parameter's value depends on the target resource for the
+ name: string, The `name` parameter's value depends on the target resource for the
request, namely
[`projects`](/iam/reference/rest/v1/projects.roles) or
[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
-resource type's `name` value format is described below:
+resource type's `name` value format is described below:
* [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete):
`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
@@ -507,7 +507,7 @@
The object takes the form of:
{ # The request to undelete an existing role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}
x__xgafv: string, V1 error format.
@@ -519,25 +519,25 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "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.
- "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.
- "name": "A String", # The name of 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.
+ "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.
}</pre>
</div>