Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / v1.6.0 / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: 36afd11e810307ec15d909ad43cf41f72c1e60b0 [file] [log] [blame]
<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">Google 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=None, 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=None, 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=None, body, 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=None, body, 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, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Projects that are visible to the user and satisfy the</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=None, body, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource=None, 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=None, body, 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=None, 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.
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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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=None, 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 the following criteria are met:
+ The Project does not have a billing account associated with it.
+ The Project 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=None, 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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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=None, body, 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. (required)
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 AppEngine 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" 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=None, body, 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.
Args:
resource: string, REQUIRED: The resource for which the policy is being requested.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (required)
body: object, The request body. (required)
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.
#
# **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"]
# }
# ]
# }
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `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`.
# Required
"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` or `joe@example.com`.
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `domain:{domain}`: A Google Apps domain name that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# 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, # Version of the `Policy`. The default version is 0.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Projects that are visible to the user and satisfy the
specified filter. This method returns Projects in an unspecified order.
New Projects do not necessarily appear at the end of the list.
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.
filter: string, An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
+ `name`
+ `id`
+ <code>labels.<em>key</em></code> where *key* is the name of a label
Some examples of using labels as filters:
|Filter|Description|
|------|-----------|
|name:*|The project has a name.|
|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&nbsp;label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
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
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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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=None, body, x__xgafv=None)</code>
<pre>Sets the IAM access control policy for the specified Project. Replaces
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.
+ There must be at least one owner who has accepted the Terms of
Service (ToS) agreement in the policy. Calling `setIamPolicy()` to
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.
+ Calling this method requires enabling the App Engine Admin API.
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.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (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.
#
# **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"]
# }
# ]
# }
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `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`.
# Required
"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` or `joe@example.com`.
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `domain:{domain}`: A Google Apps domain name that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# 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, # Version of the `Policy`. The default version is 0.
},
}
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.
#
# **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"]
# }
# ]
# }
#
# For a description of IAM and its features, see the
# [IAM developer's guide](https://cloud.google.com/iam).
"bindings": [ # Associates a list of `members` to a `role`.
# Multiple `bindings` must not be specified for the same `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`.
# Required
"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` or `joe@example.com`.
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `domain:{domain}`: A Google Apps domain name that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
"A String",
],
},
],
"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# 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, # Version of the `Policy`. The default version is 0.
}</pre>
</div>
<div class="method">
<code class="details" id="testIamPermissions">testIamPermissions(resource=None, 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.
`resource` is usually specified as a path. For example, a Project
resource is specified as `projects/{project}`. (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=None, body, 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. (required)
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=None, 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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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, AppEngine Apps, VMs, and other
# Google Cloud Platform resources.
"name": "A String", # The user-assigned display name of the Project.
# It must be 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.
#
# The only supported parent type is "organization". Once set, the parent
# cannot be modified. 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 AppEngine 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" 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\])?)?.
#
# 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>