Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 386cc8b06b57c3d4a564fe0ab0d1e51fc34270a8 / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: b447697d65410373e9e150c9e6b86c292c996a5f [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
79<p class="firstline">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.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">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][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.</p>
86<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87 <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns the IAM access control policy for specified project.</p>
89<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]90 <code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">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.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.</p>
98<p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
100<p class="firstline">Tests the specified permissions against the IAM access control policy for the specified project.</p>
101<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102 <code><a href="#undelete">undelete(projectId, x__xgafv=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]103<p class="firstline">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] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]104<p class="toc_element">
105 <code><a href="#update">update(projectId, body, x__xgafv=None)</a></code></p>
106<p class="firstline">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.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="create">create(body, x__xgafv=None)</code>
110 <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.
111
112Args:
113 body: object, The request body. (required)
114 The object takes the form of:
115
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]116{ # 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.
117 "name": "A String", # The user-assigned 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: My Project Read-write.
118 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
119 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
120 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
121 },
122 "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: tokyo-rain-123 Read-only after creation.
123 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]124 "a_key": "A String",
125 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]126 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]127 "lifecycleState": "A String", # The project lifecycle state. Read-only.
128 "createTime": "A String", # Creation time. Read-only.
129}
130
131 x__xgafv: string, V1 error format.
132
133Returns:
134 An object of the form:
135
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]136 { # 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.
137 "name": "A String", # The user-assigned 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: My Project Read-write.
138 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
139 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
140 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
141 },
142 "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: tokyo-rain-123 Read-only after creation.
143 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 "a_key": "A String",
145 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]147 "lifecycleState": "A String", # The project lifecycle state. Read-only.
148 "createTime": "A String", # Creation time. Read-only.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154 <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][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE]. This method changes the project's lifecycle state from [ACTIVE][google.cloudresourcemanager.projects.v1beta1.LifecycleState.ACTIVE] to [DELETE_REQUESTED] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. The deletion starts at an unspecified time, at which point the lifecycle state changes to [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS]. Until the deletion completes, you can check the lifecycle state checked by retrieving the project with [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject], and the project remains visible to [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects]. However, you cannot update the project. After the deletion completes, the project is not retrievable by the [GetProject] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetProject] and [ListProjects] [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.ListProjects] methods. The caller must have modify permissions for this project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]155
156Args:
157 projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
158 x__xgafv: string, V1 error format.
159
160Returns:
161 An object of the form:
162
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]163 { # 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 `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="get">get(projectId, x__xgafv=None)</code>
169 <pre>Retrieves the project identified by the specified `project_id` (for example, `my-project-123`). The caller must have read permissions for this project.
170
171Args:
172 projectId: string, The project ID (for example, `my-project-123`). Required. (required)
173 x__xgafv: string, V1 error format.
174
175Returns:
176 An object of the form:
177
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 { # 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.
179 "name": "A String", # The user-assigned 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: My Project Read-write.
180 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
181 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
182 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
183 },
184 "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: tokyo-rain-123 Read-only after creation.
185 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]186 "a_key": "A String",
187 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]188 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]189 "lifecycleState": "A String", # The project lifecycle state. Read-only.
190 "createTime": "A String", # Creation time. Read-only.
191 }</pre>
192</div>
193
194<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
196 <pre>Returns the IAM access control policy for specified project.
197
198Args:
199 resource: string, REQUIRED: The resource for which policy is being requested. Resource is usually specified as a path, such as, `projects/{project}`. (required)
200 body: object, The request body. (required)
201 The object takes the form of:
202
203{ # Request message for `GetIamPolicy` method.
204 }
205
206 x__xgafv: string, V1 error format.
207
208Returns:
209 An object of the form:
210
211 { # 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].
212 "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.
213 { # Associates `members` with a `role`.
214 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
215 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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`.
216 "A String",
217 ],
218 },
219 ],
220 "version": 42, # Version of the `Policy`. The default version is 0.
221 "etag": "A String", # Can be used to perform a read-modify-write.
222 }</pre>
223</div>
224
225<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]226 <code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
227 <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.
228
229Args:
230 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. Note: pagination is not yet supported; the server ignores this field. Optional.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]231 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 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 label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`. Optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]232 pageToken: string, A pagination token returned from a previous call to ListProject that indicates from where listing should continue. Note: pagination is not yet supported; the server ignores this field. Optional.
233 x__xgafv: string, V1 error format.
234
235Returns:
236 An object of the form:
237
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]238 { # A page of the response received from the [ListProjects][google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.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.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]239 "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. Note: pagination is not yet supported; the server will not set this field.
240 "projects": [ # The list of projects that matched the list filter. This list can be paginated.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]241 { # 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.
242 "name": "A String", # The user-assigned 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: My Project Read-write.
243 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
244 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
245 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
246 },
247 "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: tokyo-rain-123 Read-only after creation.
248 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]249 "a_key": "A String",
250 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]251 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "lifecycleState": "A String", # The project lifecycle state. Read-only.
253 "createTime": "A String", # Creation time. Read-only.
254 },
255 ],
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
261 <pre>Retrieves the next page of results.
262
263Args:
264 previous_request: The request for the previous page. (required)
265 previous_response: The response from the request for the previous page. (required)
266
267Returns:
268 A request object that you can call 'execute()' on to request the next
269 page. Returns None if there are no more items in the collection.
270 </pre>
271</div>
272
273<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]274 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
275 <pre>Sets the IAM access control policy for the specified project. We do not currently support 'domain:' prefixed members in a Binding of a Policy. Calling this method requires enabling the App Engine Admin API.
276
277Args:
278 resource: string, REQUIRED: The resource for which policy is being specified. `resource` is usually specified as a path, such as, `projects/{project}/zones/{zone}/disks/{disk}`. (required)
279 body: object, The request body. (required)
280 The object takes the form of:
281
282{ # Request message for `SetIamPolicy` method.
283 "policy": { # 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]. # 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.
284 "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.
285 { # Associates `members` with a `role`.
286 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
287 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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`.
288 "A String",
289 ],
290 },
291 ],
292 "version": 42, # Version of the `Policy`. The default version is 0.
293 "etag": "A String", # Can be used to perform a read-modify-write.
294 },
295 }
296
297 x__xgafv: string, V1 error format.
298
299Returns:
300 An object of the form:
301
302 { # 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].
303 "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.
304 { # Associates `members` with a `role`.
305 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
306 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following formats: * `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`.
307 "A String",
308 ],
309 },
310 ],
311 "version": 42, # Version of the `Policy`. The default version is 0.
312 "etag": "A String", # Can be used to perform a read-modify-write.
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
318 <pre>Tests the specified permissions against the IAM access control policy for the specified project.
319
320Args:
321 resource: string, REQUIRED: The resource for which policy detail is being requested. `resource` is usually specified as a path, such as, `projects/{project}`. (required)
322 body: object, The request body. (required)
323 The object takes the form of:
324
325{ # Request message for `TestIamPermissions` method.
326 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
327 "A String",
328 ],
329 }
330
331 x__xgafv: string, V1 error format.
332
333Returns:
334 An object of the form:
335
336 { # Response message for `TestIamPermissions` method.
337 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
338 "A String",
339 ],
340 }</pre>
341</div>
342
343<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]344 <code class="details" id="undelete">undelete(projectId, x__xgafv=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]345 <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] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_REQUESTED]. After deletion starts, as indicated by a lifecycle state of [DELETE_IN_PROGRESS] [google.cloudresourcemanager.projects.v1beta1.LifecycleState.DELETE_IN_PROGRESS], the project cannot be restored. The caller must have modify permissions for this project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]346
347Args:
348 projectId: string, The project ID (for example, `foo-bar-123`). Required. (required)
349 x__xgafv: string, V1 error format.
350
351Returns:
352 An object of the form:
353
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]354 { # 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 `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]355 }</pre>
356</div>
357
358<div class="method">
359 <code class="details" id="update">update(projectId, body, x__xgafv=None)</code>
360 <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.
361
362Args:
363 projectId: string, The project ID (for example, `my-project-123`). Required. (required)
364 body: object, The request body. (required)
365 The object takes the form of:
366
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]367{ # 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.
368 "name": "A String", # The user-assigned 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: My Project Read-write.
369 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
370 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
371 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
372 },
373 "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: tokyo-rain-123 Read-only after creation.
374 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]375 "a_key": "A String",
376 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]377 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]378 "lifecycleState": "A String", # The project lifecycle state. Read-only.
379 "createTime": "A String", # Creation time. Read-only.
380}
381
382 x__xgafv: string, V1 error format.
383
384Returns:
385 An object of the form:
386
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]387 { # 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.
388 "name": "A String", # The user-assigned 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: My Project Read-write.
389 "parent": { # A container to reference an id for any resource type. A 'resource' in Google 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, Cloud SQL database, ... # An optional reference to a parent Resource. The only supported parent type is "organization". Once set, the parent cannot be modified. Read-write.
390 "type": "A String", # Required field representing the resource type this id is for. At present, the only valid type is "organization".
391 "id": "A String", # Required field for the type-specific id. This should correspond to the id used in the type-specific API's.
392 },
393 "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: tokyo-rain-123 Read-only after creation.
394 "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: "environment" : "dev" Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]395 "a_key": "A String",
396 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]397 "projectNumber": "A String", # The number uniquely identifying the project. Example: 415104041262 Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]398 "lifecycleState": "A String", # The project lifecycle state. Read-only.
399 "createTime": "A String", # Creation time. Read-only.
400 }</pre>
401</div>
402
403</body></html>