Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: 36afd11e810307ec15d909ad43cf41f72c1e60b0 [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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="#create">create(body, useLegacyStack=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]79<p class="firstline">Creates a Project resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]81 <code><a href="#delete">delete(projectId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Marks the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]84 <code><a href="#get">get(projectId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]87 <code><a href="#getAncestry">getAncestry(projectId=None, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]90 <code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]93 <code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]94<p class="firstline">Lists Projects that are visible to the user and satisfy the</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]99 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
100<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]102 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]105 <code><a href="#undelete">undelete(projectId=None, body, x__xgafv=None)</a></code></p>
106<p class="firstline">Restores the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]108 <code><a href="#update">update(projectId=None, body, x__xgafv=None)</a></code></p>
109<p class="firstline">Updates the attributes of the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]112 <code class="details" id="create">create(body, useLegacyStack=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]113 <pre>Creates a Project resource.
114
115Initially, the Project resource is owned by its creator exclusively.
116The creator can later grant permission to others to read or update the
117Project.
118
119Several APIs are activated automatically for the Project, including
120Google Cloud Storage.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121
122Args:
123 body: object, The request body. (required)
124 The object takes the form of:
125
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]126{ # A Project is a high-level Google Cloud Platform entity. It is a
127 # container for ACLs, APIs, AppEngine Apps, VMs, and other
128 # Google Cloud Platform resources.
129 "name": "A String", # The user-assigned display name of the Project.
130 # It must be 4 to 30 characters.
131 # Allowed characters are: lowercase and uppercase letters, numbers,
132 # hyphen, single-quote, double-quote, space, and exclamation point.
133 #
134 # Example: <code>My Project</code>
135 #
136 # Read-write.
137 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
138 #
139 # The only supported parent type is "organization". Once set, the parent
140 # cannot be modified. The `parent` can be set on creation or using the
141 # `UpdateProject` method; the end user must have the
142 # `resourcemanager.projects.create` permission on the parent.
143 #
144 # Read-write.
145 # Cloud Platform is a generic term for something you (a developer) may want to
146 # interact with through one of our API's. Some examples are an AppEngine app,
147 # a Compute Engine instance, a Cloud SQL database, and so on.
148 "type": "A String", # Required field representing the resource type this id is for.
149 # At present, the valid types are "project" and "organization".
150 "id": "A String", # Required field for the type-specific id. This should correspond to the id
151 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]153 "projectId": "A String", # The unique, user-assigned ID of the Project.
154 # It must be 6 to 30 lowercase letters, digits, or hyphens.
155 # It must start with a letter.
156 # Trailing hyphens are prohibited.
157 #
158 # Example: <code>tokyo-rain-123</code>
159 #
160 # Read-only after creation.
161 "labels": { # The labels associated with this Project.
162 #
163 # Label keys must be between 1 and 63 characters long and must conform
164 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
165 #
166 # Label values must be between 0 and 63 characters long and must conform
167 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
168 #
169 # No more than 256 labels can be associated with a given resource.
170 #
171 # Clients should store labels in a representation such as JSON that does not
172 # depend on specific characters being disallowed.
173 #
174 # Example: <code>"environment" : "dev"</code>
175 #
176 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]177 "a_key": "A String",
178 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]179 "createTime": "A String", # Creation time.
180 #
181 # Read-only.
182 "lifecycleState": "A String", # The Project lifecycle state.
183 #
184 # Read-only.
185 "projectNumber": "A String", # The number uniquely identifying the project.
186 #
187 # Example: <code>415104041262</code>
188 #
189 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]190}
191
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]192 useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]193 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]194 Allowed values
195 1 - v1 error format
196 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]197
198Returns:
199 An object of the form:
200
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]201 { # A Project is a high-level Google Cloud Platform entity. It is a
202 # container for ACLs, APIs, AppEngine Apps, VMs, and other
203 # Google Cloud Platform resources.
204 "name": "A String", # The user-assigned display name of the Project.
205 # It must be 4 to 30 characters.
206 # Allowed characters are: lowercase and uppercase letters, numbers,
207 # hyphen, single-quote, double-quote, space, and exclamation point.
208 #
209 # Example: <code>My Project</code>
210 #
211 # Read-write.
212 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
213 #
214 # The only supported parent type is "organization". Once set, the parent
215 # cannot be modified. The `parent` can be set on creation or using the
216 # `UpdateProject` method; the end user must have the
217 # `resourcemanager.projects.create` permission on the parent.
218 #
219 # Read-write.
220 # Cloud Platform is a generic term for something you (a developer) may want to
221 # interact with through one of our API's. Some examples are an AppEngine app,
222 # a Compute Engine instance, a Cloud SQL database, and so on.
223 "type": "A String", # Required field representing the resource type this id is for.
224 # At present, the valid types are "project" and "organization".
225 "id": "A String", # Required field for the type-specific id. This should correspond to the id
226 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]227 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]228 "projectId": "A String", # The unique, user-assigned ID of the Project.
229 # It must be 6 to 30 lowercase letters, digits, or hyphens.
230 # It must start with a letter.
231 # Trailing hyphens are prohibited.
232 #
233 # Example: <code>tokyo-rain-123</code>
234 #
235 # Read-only after creation.
236 "labels": { # The labels associated with this Project.
237 #
238 # Label keys must be between 1 and 63 characters long and must conform
239 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
240 #
241 # Label values must be between 0 and 63 characters long and must conform
242 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
243 #
244 # No more than 256 labels can be associated with a given resource.
245 #
246 # Clients should store labels in a representation such as JSON that does not
247 # depend on specific characters being disallowed.
248 #
249 # Example: <code>"environment" : "dev"</code>
250 #
251 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]252 "a_key": "A String",
253 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]254 "createTime": "A String", # Creation time.
255 #
256 # Read-only.
257 "lifecycleState": "A String", # The Project lifecycle state.
258 #
259 # Read-only.
260 "projectNumber": "A String", # The number uniquely identifying the project.
261 #
262 # Example: <code>415104041262</code>
263 #
264 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]265 }</pre>
266</div>
267
268<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]269 <code class="details" id="delete">delete(projectId=None, x__xgafv=None)</code>
270 <pre>Marks the Project identified by the specified
271`project_id` (for example, `my-project-123`) for deletion.
272This method will only affect the Project if the following criteria are met:
273
274+ The Project does not have a billing account associated with it.
275+ The Project has a lifecycle state of
276ACTIVE.
277
278This method changes the Project's lifecycle state from
279ACTIVE
280to DELETE_REQUESTED.
281The deletion starts at an unspecified time, at which point the project is
282no longer accessible.
283
284Until the deletion completes, you can check the lifecycle state
285checked by retrieving the Project with GetProject,
286and the Project remains visible to ListProjects.
287However, you cannot update the project.
288
289After the deletion completes, the Project is not retrievable by
290the GetProject and
291ListProjects methods.
292
293The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]294
295Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]296 projectId: string, The Project ID (for example, `foo-bar-123`).
297
298Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]299 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]300 Allowed values
301 1 - v1 error format
302 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]303
304Returns:
305 An object of the form:
306
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]307 { # A generic empty message that you can re-use to avoid defining duplicated
308 # empty messages in your APIs. A typical example is to use it as the request
309 # or the response type of an API method. For instance:
310 #
311 # service Foo {
312 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
313 # }
314 #
315 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]316 }</pre>
317</div>
318
319<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]320 <code class="details" id="get">get(projectId=None, x__xgafv=None)</code>
321 <pre>Retrieves the Project identified by the specified
322`project_id` (for example, `my-project-123`).
323
324The caller must have read permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]325
326Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]327 projectId: string, The Project ID (for example, `my-project-123`).
328
329Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]330 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]331 Allowed values
332 1 - v1 error format
333 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]334
335Returns:
336 An object of the form:
337
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]338 { # A Project is a high-level Google Cloud Platform entity. It is a
339 # container for ACLs, APIs, AppEngine Apps, VMs, and other
340 # Google Cloud Platform resources.
341 "name": "A String", # The user-assigned display name of the Project.
342 # It must be 4 to 30 characters.
343 # Allowed characters are: lowercase and uppercase letters, numbers,
344 # hyphen, single-quote, double-quote, space, and exclamation point.
345 #
346 # Example: <code>My Project</code>
347 #
348 # Read-write.
349 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
350 #
351 # The only supported parent type is "organization". Once set, the parent
352 # cannot be modified. The `parent` can be set on creation or using the
353 # `UpdateProject` method; the end user must have the
354 # `resourcemanager.projects.create` permission on the parent.
355 #
356 # Read-write.
357 # Cloud Platform is a generic term for something you (a developer) may want to
358 # interact with through one of our API's. Some examples are an AppEngine app,
359 # a Compute Engine instance, a Cloud SQL database, and so on.
360 "type": "A String", # Required field representing the resource type this id is for.
361 # At present, the valid types are "project" and "organization".
362 "id": "A String", # Required field for the type-specific id. This should correspond to the id
363 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]364 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]365 "projectId": "A String", # The unique, user-assigned ID of the Project.
366 # It must be 6 to 30 lowercase letters, digits, or hyphens.
367 # It must start with a letter.
368 # Trailing hyphens are prohibited.
369 #
370 # Example: <code>tokyo-rain-123</code>
371 #
372 # Read-only after creation.
373 "labels": { # The labels associated with this Project.
374 #
375 # Label keys must be between 1 and 63 characters long and must conform
376 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
377 #
378 # Label values must be between 0 and 63 characters long and must conform
379 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
380 #
381 # No more than 256 labels can be associated with a given resource.
382 #
383 # Clients should store labels in a representation such as JSON that does not
384 # depend on specific characters being disallowed.
385 #
386 # Example: <code>"environment" : "dev"</code>
387 #
388 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]389 "a_key": "A String",
390 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]391 "createTime": "A String", # Creation time.
392 #
393 # Read-only.
394 "lifecycleState": "A String", # The Project lifecycle state.
395 #
396 # Read-only.
397 "projectNumber": "A String", # The number uniquely identifying the project.
398 #
399 # Example: <code>415104041262</code>
400 #
401 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]402 }</pre>
403</div>
404
405<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]406 <code class="details" id="getAncestry">getAncestry(projectId=None, body, x__xgafv=None)</code>
407 <pre>Gets a list of ancestors in the resource hierarchy for the Project
408identified by the specified `project_id` (for example, `my-project-123`).
409
410The caller must have read permissions for this Project.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]411
412Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]413 projectId: string, The Project ID (for example, `my-project-123`).
414
415Required. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]416 body: object, The request body. (required)
417 The object takes the form of:
418
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]419{ # The request sent to the
420 # GetAncestry
421 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]422 }
423
424 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]428
429Returns:
430 An object of the form:
431
432 { # Response from the GetAncestry method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]433 "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The
434 # first ancestor is the project itself, followed by the project's parent,
435 # etc.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]436 { # Identifying information for a single ancestor of a project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]437 "resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.
438 # Cloud Platform is a generic term for something you (a developer) may want to
439 # interact with through one of our API's. Some examples are an AppEngine app,
440 # a Compute Engine instance, a Cloud SQL database, and so on.
441 "type": "A String", # Required field representing the resource type this id is for.
442 # At present, the valid types are "project" and "organization".
443 "id": "A String", # Required field for the type-specific id. This should correspond to the id
444 # used in the type-specific API's.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]445 },
446 },
447 ],
448 }</pre>
449</div>
450
451<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]452 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>
453 <pre>Returns the IAM access control policy for the specified Project.
454Permission is denied if the policy or the resource does not exist.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]455
456Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]457 resource: string, REQUIRED: The resource for which the policy is being requested.
458`resource` is usually specified as a path. For example, a Project
459resource is specified as `projects/{project}`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]460 body: object, The request body. (required)
461 The object takes the form of:
462
463{ # Request message for `GetIamPolicy` method.
464 }
465
466 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]467 Allowed values
468 1 - v1 error format
469 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]470
471Returns:
472 An object of the form:
473
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]474 { # Defines an Identity and Access Management (IAM) policy. It is used to
475 # specify access control policies for Cloud Platform resources.
476 #
477 #
478 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
479 # `members` to a `role`, where the members can be user accounts, Google groups,
480 # Google domains, and service accounts. A `role` is a named list of permissions
481 # defined by IAM.
482 #
483 # **Example**
484 #
485 # {
486 # "bindings": [
487 # {
488 # "role": "roles/owner",
489 # "members": [
490 # "user:mike@example.com",
491 # "group:admins@example.com",
492 # "domain:google.com",
493 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
494 # ]
495 # },
496 # {
497 # "role": "roles/viewer",
498 # "members": ["user:sean@example.com"]
499 # }
500 # ]
501 # }
502 #
503 # For a description of IAM and its features, see the
504 # [IAM developer's guide](https://cloud.google.com/iam).
505 "bindings": [ # Associates a list of `members` to a `role`.
506 # Multiple `bindings` must not be specified for the same `role`.
507 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]508 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]509 "role": "A String", # Role that is assigned to `members`.
510 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
511 # Required
512 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
513 # `members` can have the following values:
514 #
515 # * `allUsers`: A special identifier that represents anyone who is
516 # on the internet; with or without a Google account.
517 #
518 # * `allAuthenticatedUsers`: A special identifier that represents anyone
519 # who is authenticated with a Google account or a service account.
520 #
521 # * `user:{emailid}`: An email address that represents a specific Google
522 # account. For example, `alice@gmail.com` or `joe@example.com`.
523 #
524 #
525 # * `serviceAccount:{emailid}`: An email address that represents a service
526 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
527 #
528 # * `group:{emailid}`: An email address that represents a Google group.
529 # For example, `admins@example.com`.
530 #
531 # * `domain:{domain}`: A Google Apps domain name that represents all the
532 # users of that domain. For example, `google.com` or `example.com`.
533 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]534 "A String",
535 ],
536 },
537 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]538 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
539 # prevent simultaneous updates of a policy from overwriting each other.
540 # It is strongly suggested that systems make use of the `etag` in the
541 # read-modify-write cycle to perform policy updates in order to avoid race
542 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
543 # systems are expected to put that etag in the request to `setIamPolicy` to
544 # ensure that their change will be applied to the same version of the policy.
545 #
546 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
547 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]548 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]549 }</pre>
550</div>
551
552<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]553 <code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]554 <pre>Lists Projects that are visible to the user and satisfy the
555specified filter. This method returns Projects in an unspecified order.
556New Projects do not necessarily appear at the end of the list.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]557
558Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]559 pageSize: integer, The maximum number of Projects to return in the response.
560The server can return fewer Projects than requested.
561If unspecified, server picks an appropriate default.
562
563Optional.
564 filter: string, An expression for filtering the results of the request. Filter rules are
565case insensitive. The fields eligible for filtering are:
566
567+ `name`
568+ `id`
569+ <code>labels.<em>key</em></code> where *key* is the name of a label
570
571Some examples of using labels as filters:
572
573|Filter|Description|
574|------|-----------|
575|name:*|The project has a name.|
576|name:Howl|The project's name is `Howl` or `howl`.|
577|name:HOWL|Equivalent to above.|
578|NAME:howl|Equivalent to above.|
579|labels.color:*|The project has the label `color`.|
580|labels.color:red|The project's label `color` has the value `red`.|
581|labels.color:red&nbsp;label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
582
583Optional.
584 pageToken: string, A pagination token returned from a previous call to ListProjects
585that indicates from where listing should continue.
586
587Optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]588 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]589 Allowed values
590 1 - v1 error format
591 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]592
593Returns:
594 An object of the form:
595
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]596 { # A page of the response received from the
597 # ListProjects
598 # method.
599 #
600 # A paginated response where more pages are available has
601 # `next_page_token` set. This token can be used in a subsequent request to
602 # retrieve the next request page.
603 "nextPageToken": "A String", # Pagination token.
604 #
605 # If the result set is too large to fit in a single response, this token
606 # is returned. It encodes the position of the current result cursor.
607 # Feeding this value into a new list request with the `page_token` parameter
608 # gives the next page of the results.
609 #
610 # When `next_page_token` is not filled in, there is no next page and
611 # the list returned is the last page in the result set.
612 #
613 # Pagination tokens have a limited lifetime.
614 "projects": [ # The list of Projects that matched the list filter. This list can
615 # be paginated.
616 { # A Project is a high-level Google Cloud Platform entity. It is a
617 # container for ACLs, APIs, AppEngine Apps, VMs, and other
618 # Google Cloud Platform resources.
619 "name": "A String", # The user-assigned display name of the Project.
620 # It must be 4 to 30 characters.
621 # Allowed characters are: lowercase and uppercase letters, numbers,
622 # hyphen, single-quote, double-quote, space, and exclamation point.
623 #
624 # Example: <code>My Project</code>
625 #
626 # Read-write.
627 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
628 #
629 # The only supported parent type is "organization". Once set, the parent
630 # cannot be modified. The `parent` can be set on creation or using the
631 # `UpdateProject` method; the end user must have the
632 # `resourcemanager.projects.create` permission on the parent.
633 #
634 # Read-write.
635 # Cloud Platform is a generic term for something you (a developer) may want to
636 # interact with through one of our API's. Some examples are an AppEngine app,
637 # a Compute Engine instance, a Cloud SQL database, and so on.
638 "type": "A String", # Required field representing the resource type this id is for.
639 # At present, the valid types are "project" and "organization".
640 "id": "A String", # Required field for the type-specific id. This should correspond to the id
641 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]642 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]643 "projectId": "A String", # The unique, user-assigned ID of the Project.
644 # It must be 6 to 30 lowercase letters, digits, or hyphens.
645 # It must start with a letter.
646 # Trailing hyphens are prohibited.
647 #
648 # Example: <code>tokyo-rain-123</code>
649 #
650 # Read-only after creation.
651 "labels": { # The labels associated with this Project.
652 #
653 # Label keys must be between 1 and 63 characters long and must conform
654 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
655 #
656 # Label values must be between 0 and 63 characters long and must conform
657 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
658 #
659 # No more than 256 labels can be associated with a given resource.
660 #
661 # Clients should store labels in a representation such as JSON that does not
662 # depend on specific characters being disallowed.
663 #
664 # Example: <code>"environment" : "dev"</code>
665 #
666 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]667 "a_key": "A String",
668 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]669 "createTime": "A String", # Creation time.
670 #
671 # Read-only.
672 "lifecycleState": "A String", # The Project lifecycle state.
673 #
674 # Read-only.
675 "projectNumber": "A String", # The number uniquely identifying the project.
676 #
677 # Example: <code>415104041262</code>
678 #
679 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]680 },
681 ],
682 }</pre>
683</div>
684
685<div class="method">
686 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
687 <pre>Retrieves the next page of results.
688
689Args:
690 previous_request: The request for the previous page. (required)
691 previous_response: The response from the request for the previous page. (required)
692
693Returns:
694 A request object that you can call 'execute()' on to request the next
695 page. Returns None if there are no more items in the collection.
696 </pre>
697</div>
698
699<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]700 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
701 <pre>Sets the IAM access control policy for the specified Project. Replaces
702any existing policy.
703
704The following constraints apply when using `setIamPolicy()`:
705
706+ Project does not support `allUsers` and `allAuthenticatedUsers` as
707`members` in a `Binding` of a `Policy`.
708
709+ The owner role can be granted only to `user` and `serviceAccount`.
710
711+ Service accounts can be made owners of a project directly
712without any restrictions. However, to be added as an owner, a user must be
713invited via Cloud Platform console and must accept the invitation.
714
715+ A user cannot be granted the owner role using `setIamPolicy()`. The user
716must be granted the owner role using the Cloud Platform Console and must
717explicitly accept the invitation.
718
719+ Invitations to grant the owner role cannot be sent using `setIamPolicy()`;
720they must be sent only using the Cloud Platform Console.
721
722+ Membership changes that leave the project without any owners that have
723accepted the Terms of Service (ToS) will be rejected.
724
725+ There must be at least one owner who has accepted the Terms of
726Service (ToS) agreement in the policy. Calling `setIamPolicy()` to
727to remove the last ToS-accepted owner from the policy will fail. This
728restriction also applies to legacy projects that no longer have owners
729who have accepted the ToS. Edits to IAM policies will be rejected until
730the lack of a ToS-accepting owner is rectified.
731
732+ Calling this method requires enabling the App Engine Admin API.
733
734Note: Removing service accounts from policies or changing their roles
735can render services completely inoperable. It is important to understand
736how the service account is being used before removing or updating its roles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]737
738Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]739 resource: string, REQUIRED: The resource for which the policy is being specified.
740`resource` is usually specified as a path. For example, a Project
741resource is specified as `projects/{project}`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]742 body: object, The request body. (required)
743 The object takes the form of:
744
745{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]746 "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
747 # the policy is limited to a few 10s of KB. An empty policy is a
748 # valid policy but certain Cloud Platform services (such as Projects)
749 # might reject them.
750 # specify access control policies for Cloud Platform resources.
751 #
752 #
753 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
754 # `members` to a `role`, where the members can be user accounts, Google groups,
755 # Google domains, and service accounts. A `role` is a named list of permissions
756 # defined by IAM.
757 #
758 # **Example**
759 #
760 # {
761 # "bindings": [
762 # {
763 # "role": "roles/owner",
764 # "members": [
765 # "user:mike@example.com",
766 # "group:admins@example.com",
767 # "domain:google.com",
768 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
769 # ]
770 # },
771 # {
772 # "role": "roles/viewer",
773 # "members": ["user:sean@example.com"]
774 # }
775 # ]
776 # }
777 #
778 # For a description of IAM and its features, see the
779 # [IAM developer's guide](https://cloud.google.com/iam).
780 "bindings": [ # Associates a list of `members` to a `role`.
781 # Multiple `bindings` must not be specified for the same `role`.
782 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]783 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]784 "role": "A String", # Role that is assigned to `members`.
785 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
786 # Required
787 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
788 # `members` can have the following values:
789 #
790 # * `allUsers`: A special identifier that represents anyone who is
791 # on the internet; with or without a Google account.
792 #
793 # * `allAuthenticatedUsers`: A special identifier that represents anyone
794 # who is authenticated with a Google account or a service account.
795 #
796 # * `user:{emailid}`: An email address that represents a specific Google
797 # account. For example, `alice@gmail.com` or `joe@example.com`.
798 #
799 #
800 # * `serviceAccount:{emailid}`: An email address that represents a service
801 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
802 #
803 # * `group:{emailid}`: An email address that represents a Google group.
804 # For example, `admins@example.com`.
805 #
806 # * `domain:{domain}`: A Google Apps domain name that represents all the
807 # users of that domain. For example, `google.com` or `example.com`.
808 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]809 "A String",
810 ],
811 },
812 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]813 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
814 # prevent simultaneous updates of a policy from overwriting each other.
815 # It is strongly suggested that systems make use of the `etag` in the
816 # read-modify-write cycle to perform policy updates in order to avoid race
817 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
818 # systems are expected to put that etag in the request to `setIamPolicy` to
819 # ensure that their change will be applied to the same version of the policy.
820 #
821 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
822 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]823 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]824 },
825 }
826
827 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]828 Allowed values
829 1 - v1 error format
830 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]831
832Returns:
833 An object of the form:
834
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]835 { # Defines an Identity and Access Management (IAM) policy. It is used to
836 # specify access control policies for Cloud Platform resources.
837 #
838 #
839 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
840 # `members` to a `role`, where the members can be user accounts, Google groups,
841 # Google domains, and service accounts. A `role` is a named list of permissions
842 # defined by IAM.
843 #
844 # **Example**
845 #
846 # {
847 # "bindings": [
848 # {
849 # "role": "roles/owner",
850 # "members": [
851 # "user:mike@example.com",
852 # "group:admins@example.com",
853 # "domain:google.com",
854 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
855 # ]
856 # },
857 # {
858 # "role": "roles/viewer",
859 # "members": ["user:sean@example.com"]
860 # }
861 # ]
862 # }
863 #
864 # For a description of IAM and its features, see the
865 # [IAM developer's guide](https://cloud.google.com/iam).
866 "bindings": [ # Associates a list of `members` to a `role`.
867 # Multiple `bindings` must not be specified for the same `role`.
868 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]869 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]870 "role": "A String", # Role that is assigned to `members`.
871 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
872 # Required
873 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
874 # `members` can have the following values:
875 #
876 # * `allUsers`: A special identifier that represents anyone who is
877 # on the internet; with or without a Google account.
878 #
879 # * `allAuthenticatedUsers`: A special identifier that represents anyone
880 # who is authenticated with a Google account or a service account.
881 #
882 # * `user:{emailid}`: An email address that represents a specific Google
883 # account. For example, `alice@gmail.com` or `joe@example.com`.
884 #
885 #
886 # * `serviceAccount:{emailid}`: An email address that represents a service
887 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
888 #
889 # * `group:{emailid}`: An email address that represents a Google group.
890 # For example, `admins@example.com`.
891 #
892 # * `domain:{domain}`: A Google Apps domain name that represents all the
893 # users of that domain. For example, `google.com` or `example.com`.
894 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]895 "A String",
896 ],
897 },
898 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]899 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
900 # prevent simultaneous updates of a policy from overwriting each other.
901 # It is strongly suggested that systems make use of the `etag` in the
902 # read-modify-write cycle to perform policy updates in order to avoid race
903 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
904 # systems are expected to put that etag in the request to `setIamPolicy` to
905 # ensure that their change will be applied to the same version of the policy.
906 #
907 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
908 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]909 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]910 }</pre>
911</div>
912
913<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]914 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]915 <pre>Returns permissions that a caller has on the specified Project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]916
917Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]918 resource: string, REQUIRED: The resource for which the policy detail is being requested.
919`resource` is usually specified as a path. For example, a Project
920resource is specified as `projects/{project}`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]921 body: object, The request body. (required)
922 The object takes the form of:
923
924{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]925 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
926 # wildcards (such as '*' or 'storage.*') are not allowed. For more
927 # information see
928 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]929 "A String",
930 ],
931 }
932
933 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]934 Allowed values
935 1 - v1 error format
936 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]937
938Returns:
939 An object of the form:
940
941 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]942 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
943 # allowed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]944 "A String",
945 ],
946 }</pre>
947</div>
948
949<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]950 <code class="details" id="undelete">undelete(projectId=None, body, x__xgafv=None)</code>
951 <pre>Restores the Project identified by the specified
952`project_id` (for example, `my-project-123`).
953You can only use this method for a Project that has a lifecycle state of
954DELETE_REQUESTED.
955After deletion starts, the Project cannot be restored.
956
957The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]958
959Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]960 projectId: string, The project ID (for example, `foo-bar-123`).
961
962Required. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]963 body: object, The request body. (required)
964 The object takes the form of:
965
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]966{ # The request sent to the UndeleteProject
967 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]968 }
969
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]970 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]971 Allowed values
972 1 - v1 error format
973 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]974
975Returns:
976 An object of the form:
977
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]978 { # A generic empty message that you can re-use to avoid defining duplicated
979 # empty messages in your APIs. A typical example is to use it as the request
980 # or the response type of an API method. For instance:
981 #
982 # service Foo {
983 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
984 # }
985 #
986 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]987 }</pre>
988</div>
989
990<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]991 <code class="details" id="update">update(projectId=None, body, x__xgafv=None)</code>
992 <pre>Updates the attributes of the Project identified by the specified
993`project_id` (for example, `my-project-123`).
994
995The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]996
997Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]998 projectId: string, The project ID (for example, `my-project-123`).
999
1000Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1001 body: object, The request body. (required)
1002 The object takes the form of:
1003
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1004{ # A Project is a high-level Google Cloud Platform entity. It is a
1005 # container for ACLs, APIs, AppEngine Apps, VMs, and other
1006 # Google Cloud Platform resources.
1007 "name": "A String", # The user-assigned display name of the Project.
1008 # It must be 4 to 30 characters.
1009 # Allowed characters are: lowercase and uppercase letters, numbers,
1010 # hyphen, single-quote, double-quote, space, and exclamation point.
1011 #
1012 # Example: <code>My Project</code>
1013 #
1014 # Read-write.
1015 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1016 #
1017 # The only supported parent type is "organization". Once set, the parent
1018 # cannot be modified. The `parent` can be set on creation or using the
1019 # `UpdateProject` method; the end user must have the
1020 # `resourcemanager.projects.create` permission on the parent.
1021 #
1022 # Read-write.
1023 # Cloud Platform is a generic term for something you (a developer) may want to
1024 # interact with through one of our API's. Some examples are an AppEngine app,
1025 # a Compute Engine instance, a Cloud SQL database, and so on.
1026 "type": "A String", # Required field representing the resource type this id is for.
1027 # At present, the valid types are "project" and "organization".
1028 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1029 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1030 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1031 "projectId": "A String", # The unique, user-assigned ID of the Project.
1032 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1033 # It must start with a letter.
1034 # Trailing hyphens are prohibited.
1035 #
1036 # Example: <code>tokyo-rain-123</code>
1037 #
1038 # Read-only after creation.
1039 "labels": { # The labels associated with this Project.
1040 #
1041 # Label keys must be between 1 and 63 characters long and must conform
1042 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1043 #
1044 # Label values must be between 0 and 63 characters long and must conform
1045 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1046 #
1047 # No more than 256 labels can be associated with a given resource.
1048 #
1049 # Clients should store labels in a representation such as JSON that does not
1050 # depend on specific characters being disallowed.
1051 #
1052 # Example: <code>"environment" : "dev"</code>
1053 #
1054 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1055 "a_key": "A String",
1056 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1057 "createTime": "A String", # Creation time.
1058 #
1059 # Read-only.
1060 "lifecycleState": "A String", # The Project lifecycle state.
1061 #
1062 # Read-only.
1063 "projectNumber": "A String", # The number uniquely identifying the project.
1064 #
1065 # Example: <code>415104041262</code>
1066 #
1067 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1068}
1069
1070 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1071 Allowed values
1072 1 - v1 error format
1073 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1074
1075Returns:
1076 An object of the form:
1077
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1078 { # A Project is a high-level Google Cloud Platform entity. It is a
1079 # container for ACLs, APIs, AppEngine Apps, VMs, and other
1080 # Google Cloud Platform resources.
1081 "name": "A String", # The user-assigned display name of the Project.
1082 # It must be 4 to 30 characters.
1083 # Allowed characters are: lowercase and uppercase letters, numbers,
1084 # hyphen, single-quote, double-quote, space, and exclamation point.
1085 #
1086 # Example: <code>My Project</code>
1087 #
1088 # Read-write.
1089 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1090 #
1091 # The only supported parent type is "organization". Once set, the parent
1092 # cannot be modified. The `parent` can be set on creation or using the
1093 # `UpdateProject` method; the end user must have the
1094 # `resourcemanager.projects.create` permission on the parent.
1095 #
1096 # Read-write.
1097 # Cloud Platform is a generic term for something you (a developer) may want to
1098 # interact with through one of our API's. Some examples are an AppEngine app,
1099 # a Compute Engine instance, a Cloud SQL database, and so on.
1100 "type": "A String", # Required field representing the resource type this id is for.
1101 # At present, the valid types are "project" and "organization".
1102 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1103 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1104 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1105 "projectId": "A String", # The unique, user-assigned ID of the Project.
1106 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1107 # It must start with a letter.
1108 # Trailing hyphens are prohibited.
1109 #
1110 # Example: <code>tokyo-rain-123</code>
1111 #
1112 # Read-only after creation.
1113 "labels": { # The labels associated with this Project.
1114 #
1115 # Label keys must be between 1 and 63 characters long and must conform
1116 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1117 #
1118 # Label values must be between 0 and 63 characters long and must conform
1119 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1120 #
1121 # No more than 256 labels can be associated with a given resource.
1122 #
1123 # Clients should store labels in a representation such as JSON that does not
1124 # depend on specific characters being disallowed.
1125 #
1126 # Example: <code>"environment" : "dev"</code>
1127 #
1128 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1129 "a_key": "A String",
1130 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]1131 "createTime": "A String", # Creation time.
1132 #
1133 # Read-only.
1134 "lifecycleState": "A String", # The Project lifecycle state.
1135 #
1136 # Read-only.
1137 "projectNumber": "A String", # The number uniquely identifying the project.
1138 #
1139 # Example: <code>415104041262</code>
1140 #
1141 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1142 }</pre>
1143</div>
1144
1145</body></html>