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