chore: regens API reference docs (#889)
diff --git a/docs/dyn/cloudresourcemanager_v2.folders.html b/docs/dyn/cloudresourcemanager_v2.folders.html
index 6ca917e..9618c2e 100644
--- a/docs/dyn/cloudresourcemanager_v2.folders.html
+++ b/docs/dyn/cloudresourcemanager_v2.folders.html
@@ -75,7 +75,7 @@
<h1><a href="cloudresourcemanager_v2.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v2.folders.html">folders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(body, parent=None, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(body=None, parent=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Folder in the resource hierarchy.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -93,29 +93,29 @@
<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="#move">move(name, body, x__xgafv=None)</a></code></p>
+ <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves a Folder under a new resource parent.</p>
<p class="toc_element">
- <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Folder, changing its display_name.</p>
<p class="toc_element">
- <code><a href="#search">search(body, x__xgafv=None)</a></code></p>
+ <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Search for folders that match specific filter criteria.</p>
<p class="toc_element">
<code><a href="#search_next">search_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="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the access control policy on a Folder, replacing any existing policy.</p>
<p class="toc_element">
- <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Folder.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels the deletion request for a Folder. This method may only be</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(body, parent=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(body=None, parent=None, x__xgafv=None)</code>
<pre>Creates a Folder in the resource hierarchy.
Returns an Operation which can be used to track the progress of the
folder creation workflow.
@@ -145,12 +145,15 @@
identified parent.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -158,18 +161,15 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}
- parent: string, The resource name of the new Folder's parent.
+ parent: string, Required. The resource name of the new Folder's parent.
Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
x__xgafv: string, V1 error format.
Allowed values
@@ -237,7 +237,7 @@
identified folder.
Args:
- name: string, the resource name of the Folder to be deleted.
+ name: string, Required. the resource name of the Folder to be deleted.
Must be of the form `folders/{folder_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -249,7 +249,10 @@
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -257,15 +260,12 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}</pre>
</div>
@@ -278,7 +278,7 @@
identified folder.
Args:
- name: string, The resource name of the Folder to retrieve.
+ name: string, Required. The resource name of the Folder to retrieve.
Must be of the form `folders/{folder_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
@@ -290,7 +290,10 @@
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -298,15 +301,12 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}</pre>
</div>
@@ -325,6 +325,17 @@
The object takes the form of:
{ # Request message for `GetIamPolicy` method.
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
+ # `GetIamPolicy`.
+ "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ #
+ # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+ # rejected.
+ #
+ # Requests for policies with any conditional bindings must specify version 3.
+ # Policies without any conditional bindings may specify any valid value or
+ # leave the field unset.
+ },
}
x__xgafv: string, V1 error format.
@@ -335,104 +346,69 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
- { # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
- "A String",
- ],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- },
- ],
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -454,7 +430,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -466,7 +442,7 @@
# ]
# },
# {
- # "service": "fooservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -474,7 +450,7 @@
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
- # "user:bar@gmail.com"
+ # "user:aliya@example.com"
# ]
# }
# ]
@@ -482,9 +458,9 @@
# ]
# }
#
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
@@ -494,7 +470,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -504,7 +480,7 @@
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
+ # jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
@@ -518,6 +494,124 @@
# `allServices` is a special value that covers all services.
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -526,9 +620,10 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
}</pre>
</div>
@@ -543,36 +638,34 @@
identified parent.
Args:
- parent: string, The resource name of the Organization or Folder whose Folders are
+ parent: string, Required. The resource name of the Organization or Folder whose Folders are
being listed.
Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
Access to this method is controlled by checking the
`resourcemanager.folders.list` permission on the `parent`.
- showDeleted: boolean, Controls whether Folders in the
+ showDeleted: boolean, Optional. Controls whether Folders in the
DELETE_REQUESTED
-state should be returned. Defaults to false. This field is optional.
- pageToken: string, A pagination token returned from a previous call to `ListFolders`
+state should be returned. Defaults to false.
+ pageToken: string, Optional. A pagination token returned from a previous call to `ListFolders`
that indicates where this listing should continue from.
-This field is optional.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, The maximum number of Folders to return in the response.
-This field is optional.
+ pageSize: integer, Optional. The maximum number of Folders to return in the response.
Returns:
An object of the form:
{ # The ListFolders response message.
- "nextPageToken": "A String", # A pagination token returned from a previous call to `ListFolders`
- # that indicates from where listing should continue.
- # This field is optional.
"folders": [ # A possibly paginated list of Folders that are direct descendants of
# the specified parent resource.
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -580,17 +673,16 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
},
],
+ "nextPageToken": "A String", # A pagination token returned from a previous call to `ListFolders`
+ # that indicates from where listing should continue.
}</pre>
</div>
@@ -609,7 +701,7 @@
</div>
<div class="method">
- <code class="details" id="move">move(name, body, x__xgafv=None)</code>
+ <code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
<pre>Moves a Folder under a new resource parent.
Returns an Operation which can be used to track the progress of the
folder move workflow.
@@ -629,13 +721,13 @@
folder's current and proposed new parent.
Args:
- name: string, The resource name of the Folder to move.
+ name: string, Required. The resource name of the Folder to move.
Must be of the form folders/{folder_id} (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The MoveFolder request message.
- "destinationParent": "A String", # The resource name of the Folder or Organization to reparent
+ "destinationParent": "A String", # Required. The resource name of the Folder or Organization to reparent
# the folder under.
# Must be of the form `folders/{folder_id}` or `organizations/{org_id}`.
}
@@ -694,7 +786,7 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Folder, changing its display_name.
Changes to the folder display_name will be rejected if they violate either
the display_name formatting rules or naming constraints described in
@@ -714,12 +806,15 @@
Args:
name: string, Output only. The resource name of the Folder.
Its format is `folders/{folder_id}`, for example: "folders/1234". (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -727,18 +822,15 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}
- updateMask: string, Fields to be updated.
+ updateMask: string, Required. Fields to be updated.
Only the `display_name` can be updated.
x__xgafv: string, V1 error format.
Allowed values
@@ -750,7 +842,10 @@
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -758,20 +853,17 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}</pre>
</div>
<div class="method">
- <code class="details" id="search">search(body, x__xgafv=None)</code>
+ <code class="details" id="search">search(body=None, x__xgafv=None)</code>
<pre>Search for folders that match specific filter criteria.
Search provides an eventually consistent view of the folders a user has
access to which meet the specified filter criteria.
@@ -780,15 +872,13 @@
permission `resourcemanager.folders.get`.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request message for searching folders.
- "pageToken": "A String", # A pagination token returned from a previous call to `SearchFolders`
+ "pageToken": "A String", # Optional. A pagination token returned from a previous call to `SearchFolders`
# that indicates from where search should continue.
- # This field is optional.
- "pageSize": 42, # The maximum number of folders to return in the response.
- # This field is optional.
+ "pageSize": 42, # Optional. The maximum number of folders to return in the response.
"query": "A String", # Search criteria used to select the Folders to return.
# If no search criteria is specified then all accessible folders will be
# returned.
@@ -802,14 +892,16 @@
#
# Some example queries are:
#
- # |Query | Description|
- # |----- | -----------|
- # |displayName=Test* | Folders whose display name starts with "Test".|
- # |lifecycleState=ACTIVE | Folders whose lifecycleState is ACTIVE.|
- # |parent=folders/123 | Folders whose parent is "folders/123".|
- # |parent=folders/123 AND lifecycleState=ACTIVE | Active folders whose parent
- # is "folders/123".| |displayName=\\"Test String\\"|Folders whose display
- # name includes both "Test" and "String".|
+ # * Query `displayName=Test*` returns Folder resources whose display name
+ # starts with "Test".
+ # * Query `lifecycleState=ACTIVE` returns Folder resources with
+ # `lifecycleState` set to `ACTIVE`.
+ # * Query `parent=folders/123` returns Folder resources that have
+ # `folders/123` as a parent resource.
+ # * Query `parent=folders/123 AND lifecycleState=ACTIVE` returns active
+ # Folder resources that have `folders/123` as a parent resource.
+ # * Query `displayName=\\"Test String\\"` returns Folder resources with
+ # display names that include both "Test" and "String".
}
x__xgafv: string, V1 error format.
@@ -825,7 +917,10 @@
# the specified parent resource.
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -833,20 +928,16 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
},
],
"nextPageToken": "A String", # A pagination token returned from a previous call to `SearchFolders`
# that indicates from where searching should continue.
- # This field is optional.
}</pre>
</div>
@@ -865,7 +956,7 @@
</div>
<div class="method">
- <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
<pre>Sets the access control policy on a Folder, replacing any existing policy.
The `resource` field should be the Folder's resource name, e.g.
"folders/1234".
@@ -875,111 +966,76 @@
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
- "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # 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)
# might reject them.
- # specify access control policies for Cloud Platform resources.
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
- { # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
- "A String",
- ],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- },
- ],
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -1001,7 +1057,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -1013,7 +1069,7 @@
# ]
# },
# {
- # "service": "fooservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1021,7 +1077,7 @@
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
- # "user:bar@gmail.com"
+ # "user:aliya@example.com"
# ]
# }
# ]
@@ -1029,9 +1085,9 @@
# ]
# }
#
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
@@ -1041,7 +1097,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -1051,7 +1107,7 @@
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
+ # jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
@@ -1065,6 +1121,124 @@
# `allServices` is a special value that covers all services.
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -1073,15 +1247,16 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
},
"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
# the fields in the mask will be modified. If no mask is provided, the
# following default mask is used:
- # paths: "bindings, etag"
- # This field is only used by Cloud IAM.
+ #
+ # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1092,104 +1267,69 @@
Returns:
An object of the form:
- { # Defines an Identity and Access Management (IAM) policy. It is used to
- # specify access control policies for Cloud Platform resources.
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
#
#
- # A `Policy` consists of a list of `bindings`. A `binding` binds a list of
- # `members` to a `role`, where the members can be user accounts, Google groups,
- # Google domains, and service accounts. A `role` is a named list of permissions
- # defined by IAM.
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
#
- # **JSON Example**
+ # Optionally, a `binding` can specify a `condition`, which is a logical
+ # expression that allows access to a resource only if the expression evaluates
+ # to `true`. A condition can add constraints based on attributes of the
+ # request, the resource, or both.
+ #
+ # **JSON example:**
#
# {
# "bindings": [
# {
- # "role": "roles/owner",
+ # "role": "roles/resourcemanager.organizationAdmin",
# "members": [
# "user:mike@example.com",
# "group:admins@example.com",
# "domain:google.com",
- # "serviceAccount:my-other-app@appspot.gserviceaccount.com"
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
# ]
# },
# {
- # "role": "roles/viewer",
- # "members": ["user:sean@example.com"]
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": ["user:eve@example.com"],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
# }
- # ]
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
- # **YAML Example**
+ # **YAML example:**
#
# bindings:
# - members:
# - user:mike@example.com
# - group:admins@example.com
# - domain:google.com
- # - serviceAccount:my-other-app@appspot.gserviceaccount.com
- # role: roles/owner
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
# - members:
- # - user:sean@example.com
- # role: roles/viewer
- #
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
#
# For a description of IAM and its features, see the
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
- "bindings": [ # Associates a list of `members` to a `role`.
- # `bindings` with no members will result in an error.
- { # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
- # `members` can have the following values:
- #
- # * `allUsers`: A special identifier that represents anyone who is
- # on the internet; with or without a Google account.
- #
- # * `allAuthenticatedUsers`: A special identifier that represents anyone
- # who is authenticated with a Google account or a service account.
- #
- # * `user:{emailid}`: An email address that represents a specific Google
- # account. For example, `alice@gmail.com` .
- #
- #
- # * `serviceAccount:{emailid}`: An email address that represents a service
- # account. For example, `my-other-app@appspot.gserviceaccount.com`.
- #
- # * `group:{emailid}`: An email address that represents a Google group.
- # For example, `admins@example.com`.
- #
- #
- # * `domain:{domain}`: The G Suite domain (primary) that represents all the
- # users of that domain. For example, `google.com` or `example.com`.
- #
- "A String",
- ],
- "condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- #
- # title: "User account presence"
- # description: "Determines whether the request has a user account"
- # expression: "size(request.user) > 0"
- "location": "A String", # An optional string indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "expression": "A String", # Textual representation of an expression in
- # Common Expression Language syntax.
- #
- # The application context of the containing message determines which
- # well-known feature set of CEL is supported.
- "description": "A String", # An optional description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "title": "A String", # An optional title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
- },
- ],
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -1211,7 +1351,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -1223,7 +1363,7 @@
# ]
# },
# {
- # "service": "fooservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com"
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1231,7 +1371,7 @@
# {
# "log_type": "DATA_WRITE",
# "exempted_members": [
- # "user:bar@gmail.com"
+ # "user:aliya@example.com"
# ]
# }
# ]
@@ -1239,9 +1379,9 @@
# ]
# }
#
- # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts foo@gmail.com from DATA_READ logging, and
- # bar@gmail.com from DATA_WRITE logging.
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
"auditLogConfigs": [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
@@ -1251,7 +1391,7 @@
# {
# "log_type": "DATA_READ",
# "exempted_members": [
- # "user:foo@gmail.com"
+ # "user:jose@example.com"
# ]
# },
# {
@@ -1261,7 +1401,7 @@
# }
#
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # foo@gmail.com from DATA_READ logging.
+ # jose@example.com from DATA_READ logging.
"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
@@ -1275,6 +1415,124 @@
# `allServices` is a special value that covers all services.
},
],
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ # NOTE: An unsatisfied condition will not allow user access via current
+ # binding. Different bindings, including their conditions, are examined
+ # independently.
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ },
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
@@ -1283,14 +1541,15 @@
# systems are expected to put that etag in the request to `setIamPolicy` to
# ensure that their change will be applied to the same version of the policy.
#
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
- # policy is overwritten blindly.
- "version": 42, # Deprecated.
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
}</pre>
</div>
<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
<pre>Returns permissions that a caller has on the specified Folder.
The `resource` field should be the Folder's resource name,
e.g. "folders/1234".
@@ -1300,7 +1559,7 @@
Args:
resource: string, REQUIRED: The resource for which the policy detail is being requested.
See the operation documentation for the appropriate value for this field. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request message for `TestIamPermissions` method.
@@ -1342,7 +1601,7 @@
identified folder.
Args:
- name: string, The resource name of the Folder to undelete.
+ name: string, Required. The resource name of the Folder to undelete.
Must be of the form `folders/{folder_id}`. (required)
body: object, The request body.
The object takes the form of:
@@ -1360,7 +1619,10 @@
{ # A Folder in an Organization's resource hierarchy, used to
# organize that Organization's resources.
- "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
+ "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
+ # Updates to the lifecycle_state must be performed via
+ # DeleteFolder and
+ # UndeleteFolder.
"displayName": "A String", # The folder’s display name.
# A folder’s display name must be unique amongst its siblings, e.g.
# no two folders with the same parent can share the same display name.
@@ -1368,15 +1630,12 @@
# letters, digits, spaces, hyphens and underscores and can be no longer
# than 30 characters. This is captured by the regular expression:
# [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.
- "lifecycleState": "A String", # Output only. The lifecycle state of the folder.
- # Updates to the lifecycle_state must be performed via
- # DeleteFolder and
- # UndeleteFolder.
- "parent": "A String", # The Folder’s parent's resource name.
- # Updates to the folder's parent must be performed via
- # MoveFolder.
"name": "A String", # Output only. The resource name of the Folder.
# Its format is `folders/{folder_id}`, for example: "folders/1234".
+ "parent": "A String", # Required. The Folder’s parent's resource name.
+ # Updates to the folder's parent must be performed via
+ # MoveFolder.
+ "createTime": "A String", # Output only. Timestamp when the Folder was created. Assigned by the server.
}</pre>
</div>