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