chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index 6d5b95d..366d4ce 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, pageToken=None, showDeleted=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, showDeleted=None, pageToken=None, view=None, pageSize=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>
@@ -116,16 +116,16 @@
{ # The request to create a new role.
"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.
"role": { # A role in the Identity and Access Management API. # The Role resource to create.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- },
+ "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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ },
}
x__xgafv: string, V1 error format.
@@ -137,16 +137,16 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }</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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ }</pre>
</div>
<div class="method">
@@ -165,16 +165,16 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }</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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ }</pre>
</div>
<div class="method">
@@ -192,31 +192,31 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }</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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, showDeleted=None, pageSize=None, view=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, showDeleted=None, pageToken=None, view=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:
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)
- pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
showDeleted: boolean, Include Roles that have been deleted.
- 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.
+ 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
@@ -229,16 +229,16 @@
"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.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- },
+ "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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ },
],
}</pre>
</div>
@@ -267,16 +267,16 @@
The object takes the form of:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }
+ "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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+}
updateMask: string, A mask describing which fields in the Role have changed.
x__xgafv: string, V1 error format.
@@ -288,16 +288,16 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }</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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ }</pre>
</div>
<div class="method">
@@ -322,16 +322,16 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "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.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "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.
- "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.
- }</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.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "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.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "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.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.
+ }</pre>
</div>
</body></html>
\ No newline at end of file