You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1523 lines
63 KiB
1523 lines
63 KiB
<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_v1beta1.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(body, useLegacyStack=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates a Project resource.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Marks the Project identified by the specified</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Retrieves the Project identified by the specified</p>
|
|
<p class="toc_element">
|
|
<code><a href="#getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
|
|
<p class="toc_element">
|
|
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
|
|
<p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</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="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Sets the IAM access control policy for the specified Project. Overwrites</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 Project.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#undelete">undelete(projectId, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Restores the Project identified by the specified</p>
|
|
<p class="toc_element">
|
|
<code><a href="#update">update(projectId, body, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates the attributes of the Project identified by the specified</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="create">create(body, useLegacyStack=None, x__xgafv=None)</code>
|
|
<pre>Creates a Project resource.
|
|
|
|
Initially, the Project resource is owned by its creator exclusively.
|
|
The creator can later grant permission to others to read or update the
|
|
Project.
|
|
|
|
Several APIs are activated automatically for the Project, including
|
|
Google Cloud Storage. The parent is identified by a specified
|
|
ResourceId, which must include both an ID and a type, such as
|
|
project, folder, or organization.
|
|
|
|
This method does not associate the new project with a billing account.
|
|
You can set or update the billing account associated with a project using
|
|
the [`projects.updateBillingInfo`]
|
|
(/billing/reference/rest/v1/projects/updateBillingInfo) method.
|
|
|
|
Args:
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
}
|
|
|
|
useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
|
|
<pre>Marks the Project identified by the specified
|
|
`project_id` (for example, `my-project-123`) for deletion.
|
|
This method will only affect the Project if it has a lifecycle state of
|
|
ACTIVE.
|
|
|
|
This method changes the Project's lifecycle state from
|
|
ACTIVE
|
|
to DELETE_REQUESTED.
|
|
The deletion starts at an unspecified time, at which point the project is
|
|
no longer accessible.
|
|
|
|
Until the deletion completes, you can check the lifecycle state
|
|
checked by retrieving the Project with GetProject,
|
|
and the Project remains visible to ListProjects.
|
|
However, you cannot update the project.
|
|
|
|
After the deletion completes, the Project is not retrievable by
|
|
the GetProject
|
|
and ListProjects
|
|
methods.
|
|
|
|
The caller must have modify permissions for this Project.
|
|
|
|
Args:
|
|
projectId: string, The Project ID (for example, `foo-bar-123`).
|
|
|
|
Required. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A generic empty message that you can re-use to avoid defining duplicated
|
|
# empty messages in your APIs. A typical example is to use it as the request
|
|
# or the response type of an API method. For instance:
|
|
#
|
|
# service Foo {
|
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
|
# }
|
|
#
|
|
# The JSON representation for `Empty` is empty JSON object `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(projectId, x__xgafv=None)</code>
|
|
<pre>Retrieves the Project identified by the specified
|
|
`project_id` (for example, `my-project-123`).
|
|
|
|
The caller must have read permissions for this Project.
|
|
|
|
Args:
|
|
projectId: string, The Project ID (for example, `my-project-123`).
|
|
|
|
Required. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</code>
|
|
<pre>Gets a list of ancestors in the resource hierarchy for the Project
|
|
identified by the specified `project_id` (for example, `my-project-123`).
|
|
|
|
The caller must have read permissions for this Project.
|
|
|
|
Args:
|
|
projectId: string, The Project ID (for example, `my-project-123`).
|
|
|
|
Required. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # The request sent to the
|
|
# GetAncestry
|
|
# method.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response from the GetAncestry method.
|
|
"ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The
|
|
# first ancestor is the project itself, followed by the project's parent,
|
|
# etc.
|
|
{ # Identifying information for a single ancestor of a project.
|
|
"resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
|
|
<pre>Returns the IAM access control policy for the specified Project.
|
|
Permission is denied if the policy or the resource does not exist.
|
|
|
|
For additional information about resource structure and identification,
|
|
see [Resource Names](/apis/design/resource_names).
|
|
|
|
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`.
|
|
"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"
|
|
"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.
|
|
"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.
|
|
"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.
|
|
"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.
|
|
},
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"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(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
|
|
<pre>Lists Projects that the caller has the `resourcemanager.projects.get`
|
|
permission on and satisfy the specified filter.
|
|
|
|
This method returns Projects in an unspecified order.
|
|
This method is eventually consistent with project mutations; this means
|
|
that a newly created project may not appear in the results or recent
|
|
updates to an existing project may not be reflected in the results. To
|
|
retrieve the latest state of a project, use the
|
|
GetProject method.
|
|
|
|
NOTE: If the request filter contains a `parent.type` and `parent.id` and
|
|
the caller has the `resourcemanager.projects.list` permission on the
|
|
parent, the results will be drawn from an alternate index which provides
|
|
more consistent results. In future versions of this API, this List method
|
|
will be split into List and Search to properly capture the behavorial
|
|
difference.
|
|
|
|
Args:
|
|
pageSize: integer, The maximum number of Projects to return in the response.
|
|
The server can return fewer Projects than requested.
|
|
If unspecified, server picks an appropriate default.
|
|
|
|
Optional.
|
|
pageToken: string, A pagination token returned from a previous call to ListProjects
|
|
that indicates from where listing should continue.
|
|
|
|
Optional.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
filter: string, An expression for filtering the results of the request. Filter rules are
|
|
case insensitive. The fields eligible for filtering are:
|
|
|
|
+ `name`
|
|
+ `id`
|
|
+ `labels.<key>` (where *key* is the name of a label)
|
|
+ `parent.type`
|
|
+ `parent.id`
|
|
|
|
Some examples of using labels as filters:
|
|
|
|
| Filter | Description |
|
|
|------------------|-----------------------------------------------------|
|
|
| name:how* | The project's name starts with "how". |
|
|
| name:Howl | The project's name is `Howl` or `howl`. |
|
|
| name:HOWL | Equivalent to above. |
|
|
| NAME:howl | Equivalent to above. |
|
|
| labels.color:* | The project has the label `color`. |
|
|
| labels.color:red | The project's label `color` has the value `red`. |
|
|
| labels.color:red labels.size:big |The project's label `color` has
|
|
the value `red` and its label `size` has the value `big`. |
|
|
|
|
If no filter is specified, the call will return projects for which the user
|
|
has the `resourcemanager.projects.get` permission.
|
|
|
|
NOTE: To perform a by-parent query (eg., what projects are directly in a
|
|
Folder), the caller must have the `resourcemanager.projects.list`
|
|
permission on the parent and the filter must contain both a `parent.type`
|
|
and a `parent.id` restriction
|
|
(example: "parent.type:folder parent.id:123"). In this case an alternate
|
|
search index is used which provides more consistent results.
|
|
|
|
Optional.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A page of the response received from the
|
|
# ListProjects
|
|
# method.
|
|
#
|
|
# A paginated response where more pages are available has
|
|
# `next_page_token` set. This token can be used in a subsequent request to
|
|
# retrieve the next request page.
|
|
"nextPageToken": "A String", # Pagination token.
|
|
#
|
|
# If the result set is too large to fit in a single response, this token
|
|
# is returned. It encodes the position of the current result cursor.
|
|
# Feeding this value into a new list request with the `page_token` parameter
|
|
# gives the next page of the results.
|
|
#
|
|
# When `next_page_token` is not filled in, there is no next page and
|
|
# the list returned is the last page in the result set.
|
|
#
|
|
# Pagination tokens have a limited lifetime.
|
|
"projects": [ # The list of Projects that matched the list filter. This list can
|
|
# be paginated.
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
},
|
|
],
|
|
}</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="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
|
|
<pre>Sets the IAM access control policy for the specified Project. Overwrites
|
|
any existing policy.
|
|
|
|
The following constraints apply when using `setIamPolicy()`:
|
|
|
|
+ Project does not support `allUsers` and `allAuthenticatedUsers` as
|
|
`members` in a `Binding` of a `Policy`.
|
|
|
|
+ The owner role can be granted only to `user` and `serviceAccount`.
|
|
|
|
+ Service accounts can be made owners of a project directly
|
|
without any restrictions. However, to be added as an owner, a user must be
|
|
invited via Cloud Platform console and must accept the invitation.
|
|
|
|
+ A user cannot be granted the owner role using `setIamPolicy()`. The user
|
|
must be granted the owner role using the Cloud Platform Console and must
|
|
explicitly accept the invitation.
|
|
|
|
+ Invitations to grant the owner role cannot be sent using
|
|
`setIamPolicy()`; they must be sent only using the Cloud Platform Console.
|
|
|
|
+ Membership changes that leave the project without any owners that have
|
|
accepted the Terms of Service (ToS) will be rejected.
|
|
|
|
+ If the project is not part of an organization, there must be at least
|
|
one owner who has accepted the Terms of Service (ToS) agreement in the
|
|
policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner
|
|
from the policy will fail. This restriction also applies to legacy
|
|
projects that no longer have owners who have accepted the ToS. Edits to
|
|
IAM policies will be rejected until the lack of a ToS-accepting owner is
|
|
rectified.
|
|
|
|
+ This method will replace the existing policy, and cannot be used to
|
|
append additional IAM settings.
|
|
|
|
Note: Removing service accounts from policies or changing their roles
|
|
can render services completely inoperable. It is important to understand
|
|
how the service account is being used before removing or updating its
|
|
roles.
|
|
|
|
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`.
|
|
"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"
|
|
"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.
|
|
"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.
|
|
"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.
|
|
"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.
|
|
},
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"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`.
|
|
"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"
|
|
"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.
|
|
"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.
|
|
"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.
|
|
"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.
|
|
},
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"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 Project.
|
|
|
|
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(projectId, body=None, x__xgafv=None)</code>
|
|
<pre>Restores the Project identified by the specified
|
|
`project_id` (for example, `my-project-123`).
|
|
You can only use this method for a Project that has a lifecycle state of
|
|
DELETE_REQUESTED.
|
|
After deletion starts, the Project cannot be restored.
|
|
|
|
The caller must have modify permissions for this Project.
|
|
|
|
Args:
|
|
projectId: string, The project ID (for example, `foo-bar-123`).
|
|
|
|
Required. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # The request sent to the UndeleteProject
|
|
# method.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A generic empty message that you can re-use to avoid defining duplicated
|
|
# empty messages in your APIs. A typical example is to use it as the request
|
|
# or the response type of an API method. For instance:
|
|
#
|
|
# service Foo {
|
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
|
# }
|
|
#
|
|
# The JSON representation for `Empty` is empty JSON object `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="update">update(projectId, body, x__xgafv=None)</code>
|
|
<pre>Updates the attributes of the Project identified by the specified
|
|
`project_id` (for example, `my-project-123`).
|
|
|
|
The caller must have modify permissions for this Project.
|
|
|
|
Args:
|
|
projectId: string, The project ID (for example, `my-project-123`).
|
|
|
|
Required. (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A Project is a high-level Google Cloud Platform entity. It is a
|
|
# container for ACLs, APIs, App Engine Apps, VMs, and other
|
|
# Google Cloud Platform resources.
|
|
"name": "A String", # The optional user-assigned display name of the Project.
|
|
# When present it must be between 4 to 30 characters.
|
|
# Allowed characters are: lowercase and uppercase letters, numbers,
|
|
# hyphen, single-quote, double-quote, space, and exclamation point.
|
|
#
|
|
# Example: <code>My Project</code>
|
|
# Read-write.
|
|
"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
|
|
#
|
|
# Supported parent types include "organization" and "folder". Once set, the
|
|
# parent cannot be cleared. The `parent` can be set on creation or using the
|
|
# `UpdateProject` method; the end user must have the
|
|
# `resourcemanager.projects.create` permission on the parent.
|
|
#
|
|
# Read-write.
|
|
# Cloud Platform is a generic term for something you (a developer) may want to
|
|
# interact with through one of our API's. Some examples are an App Engine app,
|
|
# a Compute Engine instance, a Cloud SQL database, and so on.
|
|
"type": "A String", # Required field representing the resource type this id is for.
|
|
# At present, the valid types are "project", "folder", and "organization".
|
|
"id": "A String", # Required field for the type-specific id. This should correspond to the id
|
|
# used in the type-specific API's.
|
|
},
|
|
"projectId": "A String", # The unique, user-assigned ID of the Project.
|
|
# It must be 6 to 30 lowercase letters, digits, or hyphens.
|
|
# It must start with a letter.
|
|
# Trailing hyphens are prohibited.
|
|
#
|
|
# Example: <code>tokyo-rain-123</code>
|
|
# Read-only after creation.
|
|
"labels": { # The labels associated with this Project.
|
|
#
|
|
# Label keys must be between 1 and 63 characters long and must conform
|
|
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
|
|
#
|
|
# Label values must be between 0 and 63 characters long and must conform
|
|
# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
|
|
# value can be empty.
|
|
#
|
|
# No more than 256 labels can be associated with a given resource.
|
|
#
|
|
# Clients should store labels in a representation such as JSON that does not
|
|
# depend on specific characters being disallowed.
|
|
#
|
|
# Example: <code>"environment" : "dev"</code>
|
|
# Read-write.
|
|
"a_key": "A String",
|
|
},
|
|
"createTime": "A String", # Creation time.
|
|
#
|
|
# Read-only.
|
|
"lifecycleState": "A String", # The Project lifecycle state.
|
|
#
|
|
# Read-only.
|
|
"projectNumber": "A String", # The number uniquely identifying the project.
|
|
#
|
|
# Example: <code>415104041262</code>
|
|
# Read-only.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |