|
|
<html><body>
|
|
|
<style>
|
|
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
|
margin: 0;
|
|
|
padding: 0;
|
|
|
border: 0;
|
|
|
font-weight: inherit;
|
|
|
font-style: inherit;
|
|
|
font-size: 100%;
|
|
|
font-family: inherit;
|
|
|
vertical-align: baseline;
|
|
|
}
|
|
|
|
|
|
body {
|
|
|
font-size: 13px;
|
|
|
padding: 1em;
|
|
|
}
|
|
|
|
|
|
h1 {
|
|
|
font-size: 26px;
|
|
|
margin-bottom: 1em;
|
|
|
}
|
|
|
|
|
|
h2 {
|
|
|
font-size: 24px;
|
|
|
margin-bottom: 1em;
|
|
|
}
|
|
|
|
|
|
h3 {
|
|
|
font-size: 20px;
|
|
|
margin-bottom: 1em;
|
|
|
margin-top: 1em;
|
|
|
}
|
|
|
|
|
|
pre, code {
|
|
|
line-height: 1.5;
|
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
|
}
|
|
|
|
|
|
pre {
|
|
|
margin-top: 0.5em;
|
|
|
}
|
|
|
|
|
|
h1, h2, h3, p {
|
|
|
font-family: Arial, sans serif;
|
|
|
}
|
|
|
|
|
|
h1, h2, h3 {
|
|
|
border-bottom: solid #CCC 1px;
|
|
|
}
|
|
|
|
|
|
.toc_element {
|
|
|
margin-top: 0.5em;
|
|
|
}
|
|
|
|
|
|
.firstline {
|
|
|
margin-left: 2 em;
|
|
|
}
|
|
|
|
|
|
.method {
|
|
|
margin-top: 1em;
|
|
|
border: solid 1px #CCC;
|
|
|
padding: 1em;
|
|
|
background: #EEE;
|
|
|
}
|
|
|
|
|
|
.details {
|
|
|
font-weight: bold;
|
|
|
font-size: 14px;
|
|
|
}
|
|
|
|
|
|
</style>
|
|
|
|
|
|
<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>
|
|
|
<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>
|
|
|
<p class="firstline">Requests deletion of a Folder. The Folder is moved into the</p>
|
|
|
<p class="toc_element">
|
|
|
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
|
|
|
<p class="firstline">Retrieves a Folder identified by the supplied resource name.</p>
|
|
|
<p class="toc_element">
|
|
|
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
|
|
|
<p class="firstline">Gets the access control policy for a Folder. The returned policy may be</p>
|
|
|
<p class="toc_element">
|
|
|
<code><a href="#list">list(parent=None, showDeleted=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
|
|
|
<p class="firstline">Lists the Folders that are direct descendants of supplied parent resource.</p>
|
|
|
<p class="toc_element">
|
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
|
<p class="toc_element">
|
|
|
<code><a href="#move">move(name, body, 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>
|
|
|
<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>
|
|
|
<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>
|
|
|
<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>
|
|
|
<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>
|
|
|
<pre>Creates a Folder in the resource hierarchy.
|
|
|
Returns an Operation which can be used to track the progress of the
|
|
|
folder creation workflow.
|
|
|
Upon success the Operation.response field will be populated with the
|
|
|
created Folder.
|
|
|
|
|
|
In order to succeed, the addition of this new Folder must not violate
|
|
|
the Folder naming, height or fanout constraints.
|
|
|
|
|
|
+ The Folder's display_name must be distinct from all other Folder's that
|
|
|
share its parent.
|
|
|
+ The addition of the Folder must not cause the active Folder hierarchy
|
|
|
to exceed a height of 4. Note, the full active + deleted Folder hierarchy
|
|
|
is allowed to reach a height of 8; this provides additional headroom when
|
|
|
moving folders that contain deleted folders.
|
|
|
+ The addition of the Folder must not cause the total number of Folders
|
|
|
under its parent to exceed 100.
|
|
|
|
|
|
If the operation fails due to a folder constraint violation, some errors
|
|
|
may be returned by the CreateFolder request, with status code
|
|
|
FAILED_PRECONDITION and an error description. Other folder constraint
|
|
|
violations will be communicated in the Operation, with the specific
|
|
|
PreconditionFailure returned via the details list in the Operation.error
|
|
|
field.
|
|
|
|
|
|
The caller must have `resourcemanager.folders.create` permission on the
|
|
|
identified parent.
|
|
|
|
|
|
Args:
|
|
|
body: object, The request body. (required)
|
|
|
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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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: string, 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
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # This resource represents a long-running operation that is the result of a
|
|
|
# network API call.
|
|
|
"response": { # The normal response of the operation in case of success. If the original
|
|
|
# method returns no data on success, such as `Delete`, the response is
|
|
|
# `google.protobuf.Empty`. If the original method is standard
|
|
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
|
|
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
|
|
# is the original method name. For example, if the original method name
|
|
|
# is `TakeSnapshot()`, the inferred response type is
|
|
|
# `TakeSnapshotResponse`.
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
"metadata": { # Service-specific metadata associated with the operation. It typically
|
|
|
# contains progress information and common metadata such as create time.
|
|
|
# Some services might not provide such metadata. Any method that returns a
|
|
|
# long-running operation should document the metadata type, if any.
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
"done": True or False, # If the value is `false`, it means the operation is still in progress.
|
|
|
# If `true`, the operation is completed, and either `error` or `response` is
|
|
|
# available.
|
|
|
"name": "A String", # The server-assigned name, which is only unique within the same service that
|
|
|
# originally returns it. If you use the default HTTP mapping, the
|
|
|
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
|
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
|
|
|
# different programming environments, including REST APIs and RPC APIs. It is
|
|
|
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
|
|
# three pieces of data: error code, error message, and error details.
|
|
|
#
|
|
|
# You can find out more about this error model and how to work with it in the
|
|
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
|
"message": "A String", # A developer-facing error message, which should be in English. Any
|
|
|
# user-facing error message should be localized and sent in the
|
|
|
# google.rpc.Status.details field, or localized by the client.
|
|
|
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
|
|
|
"details": [ # A list of messages that carry the error details. There is a common set of
|
|
|
# message types for APIs to use.
|
|
|
{
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
],
|
|
|
},
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
|
|
|
<pre>Requests deletion of a Folder. The Folder is moved into the
|
|
|
DELETE_REQUESTED state
|
|
|
immediately, and is deleted approximately 30 days later. This method may
|
|
|
only be called on an empty Folder in the
|
|
|
ACTIVE state, where a Folder is empty if
|
|
|
it doesn't contain any Folders or Projects in the
|
|
|
ACTIVE state.
|
|
|
The caller must have `resourcemanager.folders.delete` permission on the
|
|
|
identified folder.
|
|
|
|
|
|
Args:
|
|
|
name: string, 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
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # 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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
|
|
<pre>Retrieves a Folder identified by the supplied resource name.
|
|
|
Valid Folder resource names have the format `folders/{folder_id}`
|
|
|
(for example, `folders/1234`).
|
|
|
The caller must have `resourcemanager.folders.get` permission on the
|
|
|
identified folder.
|
|
|
|
|
|
Args:
|
|
|
name: string, 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
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # 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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
|
|
|
<pre>Gets the access control policy for a Folder. The returned policy may be
|
|
|
empty if no such policy or resource exists. The `resource` field should
|
|
|
be the Folder's resource name, e.g. "folders/1234".
|
|
|
The caller must have `resourcemanager.folders.getIamPolicy` permission
|
|
|
on the identified folder.
|
|
|
|
|
|
Args:
|
|
|
resource: string, REQUIRED: The resource for which the policy is being requested.
|
|
|
See the operation documentation for the appropriate value for this field. (required)
|
|
|
body: object, The request body.
|
|
|
The object takes the form of:
|
|
|
|
|
|
{ # Request message for `GetIamPolicy` method.
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
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.
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
#
|
|
|
# **JSON Example**
|
|
|
#
|
|
|
# {
|
|
|
# "bindings": [
|
|
|
# {
|
|
|
# "role": "roles/owner",
|
|
|
# "members": [
|
|
|
# "user:mike@example.com",
|
|
|
# "group:admins@example.com",
|
|
|
# "domain:google.com",
|
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "role": "roles/viewer",
|
|
|
# "members": ["user:sean@example.com"]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# **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
|
|
|
# - members:
|
|
|
# - user:sean@example.com
|
|
|
# role: roles/viewer
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
},
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# identities, if any, are exempted from logging.
|
|
|
# An AuditConfig must have one or more AuditLogConfigs.
|
|
|
#
|
|
|
# If there are AuditConfigs for both `allServices` and a specific service,
|
|
|
# the union of the two AuditConfigs is used for that service: the log_types
|
|
|
# specified in each AuditConfig are enabled, and the exempted_members in each
|
|
|
# AuditLogConfig are exempted.
|
|
|
#
|
|
|
# Example Policy with multiple AuditConfigs:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_configs": [
|
|
|
# {
|
|
|
# "service": "allServices"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "ADMIN_READ",
|
|
|
# }
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "service": "fooservice.googleapis.com"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# "exempted_members": [
|
|
|
# "user:bar@gmail.com"
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# 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.
|
|
|
"auditLogConfigs": [ # The configuration for logging of each type of permission.
|
|
|
{ # Provides the configuration for logging a type of permissions.
|
|
|
# Example:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
|
# foo@gmail.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.
|
|
|
"A String",
|
|
|
],
|
|
|
"logType": "A String", # The log type that this config enables.
|
|
|
},
|
|
|
],
|
|
|
"service": "A String", # Specifies a service that will be enabled for audit logging.
|
|
|
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
|
|
|
# `allServices` is a special value that covers all services.
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# read-modify-write cycle to perform policy updates in order to avoid race
|
|
|
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
|
|
# 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.
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="list">list(parent=None, showDeleted=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
|
|
|
<pre>Lists the Folders that are direct descendants of supplied parent resource.
|
|
|
List provides a strongly consistent view of the Folders underneath
|
|
|
the specified parent resource.
|
|
|
List returns Folders sorted based upon the (ascending) lexical ordering
|
|
|
of their display_name.
|
|
|
The caller must have `resourcemanager.folders.list` permission on the
|
|
|
identified parent.
|
|
|
|
|
|
Args:
|
|
|
parent: string, 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
|
|
|
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`
|
|
|
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.
|
|
|
|
|
|
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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
},
|
|
|
],
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
|
<pre>Retrieves the next page of results.
|
|
|
|
|
|
Args:
|
|
|
previous_request: The request for the previous page. (required)
|
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
|
|
Returns:
|
|
|
A request object that you can call 'execute()' on to request the next
|
|
|
page. Returns None if there are no more items in the collection.
|
|
|
</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="move">move(name, body, 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.
|
|
|
Upon success the Operation.response field will be populated with the
|
|
|
moved Folder.
|
|
|
Upon failure, a FolderOperationError categorizing the failure cause will
|
|
|
be returned - if the failure occurs synchronously then the
|
|
|
FolderOperationError will be returned via the Status.details field
|
|
|
and if it occurs asynchronously then the FolderOperation will be returned
|
|
|
via the Operation.error field.
|
|
|
In addition, the Operation.metadata field will be populated with a
|
|
|
FolderOperation message as an aid to stateless clients.
|
|
|
Folder moves will be rejected if they violate either the naming, height
|
|
|
or fanout constraints described in the
|
|
|
CreateFolder documentation.
|
|
|
The caller must have `resourcemanager.folders.move` permission on the
|
|
|
folder's current and proposed new parent.
|
|
|
|
|
|
Args:
|
|
|
name: string, The resource name of the Folder to move.
|
|
|
Must be of the form folders/{folder_id} (required)
|
|
|
body: object, The request body. (required)
|
|
|
The object takes the form of:
|
|
|
|
|
|
{ # The MoveFolder request message.
|
|
|
"destinationParent": "A String", # 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}`.
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # This resource represents a long-running operation that is the result of a
|
|
|
# network API call.
|
|
|
"response": { # The normal response of the operation in case of success. If the original
|
|
|
# method returns no data on success, such as `Delete`, the response is
|
|
|
# `google.protobuf.Empty`. If the original method is standard
|
|
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
|
|
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
|
|
# is the original method name. For example, if the original method name
|
|
|
# is `TakeSnapshot()`, the inferred response type is
|
|
|
# `TakeSnapshotResponse`.
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
"metadata": { # Service-specific metadata associated with the operation. It typically
|
|
|
# contains progress information and common metadata such as create time.
|
|
|
# Some services might not provide such metadata. Any method that returns a
|
|
|
# long-running operation should document the metadata type, if any.
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
"done": True or False, # If the value is `false`, it means the operation is still in progress.
|
|
|
# If `true`, the operation is completed, and either `error` or `response` is
|
|
|
# available.
|
|
|
"name": "A String", # The server-assigned name, which is only unique within the same service that
|
|
|
# originally returns it. If you use the default HTTP mapping, the
|
|
|
# `name` should be a resource name ending with `operations/{unique_id}`.
|
|
|
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
|
|
|
# different programming environments, including REST APIs and RPC APIs. It is
|
|
|
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
|
|
# three pieces of data: error code, error message, and error details.
|
|
|
#
|
|
|
# You can find out more about this error model and how to work with it in the
|
|
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
|
"message": "A String", # A developer-facing error message, which should be in English. Any
|
|
|
# user-facing error message should be localized and sent in the
|
|
|
# google.rpc.Status.details field, or localized by the client.
|
|
|
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
|
|
|
"details": [ # A list of messages that carry the error details. There is a common set of
|
|
|
# message types for APIs to use.
|
|
|
{
|
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
|
},
|
|
|
],
|
|
|
},
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="patch">patch(name, body, 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
|
|
|
the CreateFolder documentation.
|
|
|
|
|
|
The Folder's display name must start and end with a letter or digit,
|
|
|
may contain 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}])?.
|
|
|
The caller must have `resourcemanager.folders.update` permission on the
|
|
|
identified folder.
|
|
|
|
|
|
If the update fails due to the unique name constraint then a
|
|
|
PreconditionFailure explaining this violation will be returned
|
|
|
in the Status.details field.
|
|
|
|
|
|
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)
|
|
|
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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
}
|
|
|
|
|
|
updateMask: string, Fields to be updated.
|
|
|
Only the `display_name` can be updated.
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # 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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="search">search(body, 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.
|
|
|
|
|
|
This will only return folders on which the caller has the
|
|
|
permission `resourcemanager.folders.get`.
|
|
|
|
|
|
Args:
|
|
|
body: object, The request body. (required)
|
|
|
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`
|
|
|
# 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.
|
|
|
"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.
|
|
|
#
|
|
|
# Query expressions can be used to restrict results based upon displayName,
|
|
|
# lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
|
|
|
# can be used along with the suffix wildcard symbol `*`.
|
|
|
#
|
|
|
# The displayName field in a query expression should use escaped quotes
|
|
|
# for values that include whitespace to prevent unexpected behavior.
|
|
|
#
|
|
|
# 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".|
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # The response message for searching folders.
|
|
|
"folders": [ # A possibly paginated folder search results.
|
|
|
# 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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
},
|
|
|
],
|
|
|
"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>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="search_next">search_next(previous_request, previous_response)</code>
|
|
|
<pre>Retrieves the next page of results.
|
|
|
|
|
|
Args:
|
|
|
previous_request: The request for the previous page. (required)
|
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
|
|
Returns:
|
|
|
A request object that you can call 'execute()' on to request the next
|
|
|
page. Returns None if there are no more items in the collection.
|
|
|
</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, 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".
|
|
|
The caller must have `resourcemanager.folders.setIamPolicy` permission
|
|
|
on the identified folder.
|
|
|
|
|
|
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)
|
|
|
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
|
|
|
# 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.
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
#
|
|
|
# **JSON Example**
|
|
|
#
|
|
|
# {
|
|
|
# "bindings": [
|
|
|
# {
|
|
|
# "role": "roles/owner",
|
|
|
# "members": [
|
|
|
# "user:mike@example.com",
|
|
|
# "group:admins@example.com",
|
|
|
# "domain:google.com",
|
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "role": "roles/viewer",
|
|
|
# "members": ["user:sean@example.com"]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# **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
|
|
|
# - members:
|
|
|
# - user:sean@example.com
|
|
|
# role: roles/viewer
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
},
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# identities, if any, are exempted from logging.
|
|
|
# An AuditConfig must have one or more AuditLogConfigs.
|
|
|
#
|
|
|
# If there are AuditConfigs for both `allServices` and a specific service,
|
|
|
# the union of the two AuditConfigs is used for that service: the log_types
|
|
|
# specified in each AuditConfig are enabled, and the exempted_members in each
|
|
|
# AuditLogConfig are exempted.
|
|
|
#
|
|
|
# Example Policy with multiple AuditConfigs:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_configs": [
|
|
|
# {
|
|
|
# "service": "allServices"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "ADMIN_READ",
|
|
|
# }
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "service": "fooservice.googleapis.com"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# "exempted_members": [
|
|
|
# "user:bar@gmail.com"
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# 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.
|
|
|
"auditLogConfigs": [ # The configuration for logging of each type of permission.
|
|
|
{ # Provides the configuration for logging a type of permissions.
|
|
|
# Example:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
|
# foo@gmail.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.
|
|
|
"A String",
|
|
|
],
|
|
|
"logType": "A String", # The log type that this config enables.
|
|
|
},
|
|
|
],
|
|
|
"service": "A String", # Specifies a service that will be enabled for audit logging.
|
|
|
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
|
|
|
# `allServices` is a special value that covers all services.
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# read-modify-write cycle to perform policy updates in order to avoid race
|
|
|
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
|
|
# 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.
|
|
|
},
|
|
|
"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.
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
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.
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
#
|
|
|
# **JSON Example**
|
|
|
#
|
|
|
# {
|
|
|
# "bindings": [
|
|
|
# {
|
|
|
# "role": "roles/owner",
|
|
|
# "members": [
|
|
|
# "user:mike@example.com",
|
|
|
# "group:admins@example.com",
|
|
|
# "domain:google.com",
|
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "role": "roles/viewer",
|
|
|
# "members": ["user:sean@example.com"]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# **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
|
|
|
# - members:
|
|
|
# - user:sean@example.com
|
|
|
# role: roles/viewer
|
|
|
#
|
|
|
#
|
|
|
# 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.
|
|
|
},
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# identities, if any, are exempted from logging.
|
|
|
# An AuditConfig must have one or more AuditLogConfigs.
|
|
|
#
|
|
|
# If there are AuditConfigs for both `allServices` and a specific service,
|
|
|
# the union of the two AuditConfigs is used for that service: the log_types
|
|
|
# specified in each AuditConfig are enabled, and the exempted_members in each
|
|
|
# AuditLogConfig are exempted.
|
|
|
#
|
|
|
# Example Policy with multiple AuditConfigs:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_configs": [
|
|
|
# {
|
|
|
# "service": "allServices"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "ADMIN_READ",
|
|
|
# }
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "service": "fooservice.googleapis.com"
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# "exempted_members": [
|
|
|
# "user:bar@gmail.com"
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# 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.
|
|
|
"auditLogConfigs": [ # The configuration for logging of each type of permission.
|
|
|
{ # Provides the configuration for logging a type of permissions.
|
|
|
# Example:
|
|
|
#
|
|
|
# {
|
|
|
# "audit_log_configs": [
|
|
|
# {
|
|
|
# "log_type": "DATA_READ",
|
|
|
# "exempted_members": [
|
|
|
# "user:foo@gmail.com"
|
|
|
# ]
|
|
|
# },
|
|
|
# {
|
|
|
# "log_type": "DATA_WRITE",
|
|
|
# }
|
|
|
# ]
|
|
|
# }
|
|
|
#
|
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
|
# foo@gmail.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.
|
|
|
"A String",
|
|
|
],
|
|
|
"logType": "A String", # The log type that this config enables.
|
|
|
},
|
|
|
],
|
|
|
"service": "A String", # Specifies a service that will be enabled for audit logging.
|
|
|
# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
|
|
|
# `allServices` is a special value that covers all services.
|
|
|
},
|
|
|
],
|
|
|
"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
|
|
|
# read-modify-write cycle to perform policy updates in order to avoid race
|
|
|
# conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
|
|
# 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.
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, 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".
|
|
|
|
|
|
There are no permissions required for making this API call.
|
|
|
|
|
|
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)
|
|
|
The object takes the form of:
|
|
|
|
|
|
{ # Request message for `TestIamPermissions` method.
|
|
|
"permissions": [ # The set of permissions to check for the `resource`. Permissions with
|
|
|
# wildcards (such as '*' or 'storage.*') are not allowed. For more
|
|
|
# information see
|
|
|
# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
|
|
"A String",
|
|
|
],
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # Response message for `TestIamPermissions` method.
|
|
|
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
|
|
|
# allowed.
|
|
|
"A String",
|
|
|
],
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
<div class="method">
|
|
|
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
|
|
|
<pre>Cancels the deletion request for a Folder. This method may only be
|
|
|
called on a Folder in the
|
|
|
DELETE_REQUESTED state.
|
|
|
In order to succeed, the Folder's parent must be in the
|
|
|
ACTIVE state.
|
|
|
In addition, reintroducing the folder into the tree must not violate
|
|
|
folder naming, height and fanout constraints described in the
|
|
|
CreateFolder documentation.
|
|
|
The caller must have `resourcemanager.folders.undelete` permission on the
|
|
|
identified folder.
|
|
|
|
|
|
Args:
|
|
|
name: string, 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:
|
|
|
|
|
|
{ # The UndeleteFolder request message.
|
|
|
}
|
|
|
|
|
|
x__xgafv: string, V1 error format.
|
|
|
Allowed values
|
|
|
1 - v1 error format
|
|
|
2 - v2 error format
|
|
|
|
|
|
Returns:
|
|
|
An object of the form:
|
|
|
|
|
|
{ # 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.
|
|
|
"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.
|
|
|
# The display name must start and end with a letter or digit, may contain
|
|
|
# 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".
|
|
|
}</pre>
|
|
|
</div>
|
|
|
|
|
|
</body></html> |
