docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index f873017..7a75a80 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the definition of a Role.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, showDeleted=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -115,15 +115,15 @@
{ # The request to create a new 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
},
"roleId": "A String", # The role ID to use for this role. A role ID may contain alphanumeric characters, underscores (`_`), and periods (`.`). It must contain a minimum of 3 characters and a maximum of 64 characters.
}
@@ -137,15 +137,15 @@
An object of the form:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}</pre>
</div>
@@ -165,15 +165,15 @@
An object of the form:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}</pre>
</div>
@@ -192,31 +192,31 @@
An object of the form:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, showDeleted=None, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, showDeleted=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:
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: * [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string. 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` * [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list): `projects/{PROJECT_ID}`. This method lists all project-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles` * [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list): `organizations/{ORGANIZATION_ID}`. This method lists all organization-level [custom roles](/iam/docs/understanding-custom-roles). Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
- 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. The default is 300, and the maximum is 1,000.
+ pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
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.
Allowed values
BASIC - Omits the `included_permissions` field. This is the default value.
FULL - Returns all fields.
+ showDeleted: boolean, Include Roles that have been deleted.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -226,20 +226,20 @@
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.
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
},
],
- "nextPageToken": "A String", # To retrieve the next page of results, set `ListRolesRequest.page_token` to this value.
}</pre>
</div>
@@ -267,15 +267,15 @@
The object takes the form of:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}
updateMask: string, A mask describing which fields in the Role have changed.
@@ -288,15 +288,15 @@
An object of the form:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}</pre>
</div>
@@ -322,15 +322,15 @@
An object of the form:
{ # 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "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.
- "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.
- "etag": "A String", # Used to perform a consistent read-modify-write.
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
"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. 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.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
}</pre>
</div>