blob: e6f00513f5461a7f3b3c679249025e57825d2ad8 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001<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 -070078 <code><a href="#create">create(body, useLegacyStack=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080079<p class="firstline">Creates a Project resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000080<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070081 <code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080082<p class="firstline">Marks the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000083<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070084 <code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080085<p class="firstline">Retrieves the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000086<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070087 <code><a href="#getAncestry">getAncestry(projectId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080088<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070089<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070090 <code><a href="#getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080091<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070092<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +000093 <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 -080094<p class="firstline">Lists Projects that are visible to the user and satisfy the</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +000095<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 -070099 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800100<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700101<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700102 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800103<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700104<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700105 <code><a href="#undelete">undelete(projectId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800106<p class="firstline">Restores the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000107<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700108 <code><a href="#update">update(projectId, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800109<p class="firstline">Updates the attributes of the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000110<h3>Method Details</h3>
111<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700112 <code class="details" id="create">create(body, useLegacyStack=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800113 <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 +0000121
122Args:
123 body: object, The request body. (required)
124 The object takes the form of:
125
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800126{ # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400127 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800128 # 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 -0800135 # 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 -0400145 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800146 # 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 -0700151 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800152 "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 -0800158 # 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 -0800173 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000174 "a_key": "A String",
175 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700176 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800177 #
178 # Read-only.
179 "lifecycleState": "A String", # The Project lifecycle state.
180 #
181 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -0700182 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800183 #
Thomas Coffee2f245372017-03-27 10:39:26 -0700184 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800185 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000186}
187
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700188 useLegacyStack: boolean, A safety hatch to opt out of the new reliable project creation process.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000189 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000193
194Returns:
195 An object of the form:
196
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800197 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400198 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800199 # 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 -0800206 # 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 -0400216 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800217 # 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 -0700222 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800223 "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 -0800229 # 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 -0800244 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000245 "a_key": "A String",
246 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700247 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800248 #
249 # Read-only.
250 "lifecycleState": "A String", # The Project lifecycle state.
251 #
252 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -0700253 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800254 #
Thomas Coffee2f245372017-03-27 10:39:26 -0700255 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800256 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000257 }</pre>
258</div>
259
260<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700261 <code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800262 <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 +0000286
287Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800288 projectId: string, The Project ID (for example, `foo-bar-123`).
289
290Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000291 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000295
296Returns:
297 An object of the form:
298
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800299 { # 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 +0000308 }</pre>
309</div>
310
311<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700312 <code class="details" id="get">get(projectId, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800313 <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 +0000317
318Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800319 projectId: string, The Project ID (for example, `my-project-123`).
320
321Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000322 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800323 Allowed values
324 1 - v1 error format
325 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000326
327Returns:
328 An object of the form:
329
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800330 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400331 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800332 # 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 -0800339 # 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 -0400349 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800350 # 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 -0700355 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800356 "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 -0800362 # 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 -0800377 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000378 "a_key": "A String",
379 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700380 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800381 #
382 # Read-only.
383 "lifecycleState": "A String", # The Project lifecycle state.
384 #
385 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -0700386 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800387 #
Thomas Coffee2f245372017-03-27 10:39:26 -0700388 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800389 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000390 }</pre>
391</div>
392
393<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700394 <code class="details" id="getAncestry">getAncestry(projectId, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800395 <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 -0700399
400Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800401 projectId: string, The Project ID (for example, `my-project-123`).
402
403Required. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700404 body: object, The request body. (required)
405 The object takes the form of:
406
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800407{ # The request sent to the
408 # GetAncestry
409 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700410 }
411
412 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800413 Allowed values
414 1 - v1 error format
415 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700416
417Returns:
418 An object of the form:
419
420 { # Response from the GetAncestry method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800421 "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 -0700424 { # Identifying information for a single ancestor of a project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800425 "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 -0400427 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800428 # 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 -0700433 },
434 },
435 ],
436 }</pre>
437</div>
438
439<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700440 <code class="details" id="getIamPolicy">getIamPolicy(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800441 <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 -0700443
444Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800445 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400446See the operation documentation for the appropriate value for this field. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700447 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 -0800454 Allowed values
455 1 - v1 error format
456 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700457
458Returns:
459 An object of the form:
460
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800461 { # 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 -0700495 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800496 "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 #
518 # * `domain:{domain}`: A Google Apps domain name that represents all the
519 # users of that domain. For example, `google.com` or `example.com`.
520 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700521 "A String",
522 ],
523 },
524 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700525 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
526 # prevent simultaneous updates of a policy from overwriting each other.
527 # It is strongly suggested that systems make use of the `etag` in the
528 # read-modify-write cycle to perform policy updates in order to avoid race
529 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
530 # systems are expected to put that etag in the request to `setIamPolicy` to
531 # ensure that their change will be applied to the same version of the policy.
532 #
533 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
534 # policy is overwritten blindly.
535 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400536 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
537 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700538 # The configuration determines which permission types are logged, and what
539 # identities, if any, are exempted from logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400540 # An AuditConifg must have one or more AuditLogConfigs.
541 #
542 # If there are AuditConfigs for both `allServices` and a specific service,
543 # the union of the two AuditConfigs is used for that service: the log_types
544 # specified in each AuditConfig are enabled, and the exempted_members in each
545 # AuditConfig are exempted.
546 # Example Policy with multiple AuditConfigs:
547 # {
548 # "audit_configs": [
549 # {
550 # "service": "allServices"
551 # "audit_log_configs": [
552 # {
553 # "log_type": "DATA_READ",
554 # "exempted_members": [
555 # "user:foo@gmail.com"
556 # ]
557 # },
558 # {
559 # "log_type": "DATA_WRITE",
560 # },
561 # {
562 # "log_type": "ADMIN_READ",
563 # }
564 # ]
565 # },
566 # {
567 # "service": "fooservice@googleapis.com"
568 # "audit_log_configs": [
569 # {
570 # "log_type": "DATA_READ",
571 # },
572 # {
573 # "log_type": "DATA_WRITE",
574 # "exempted_members": [
575 # "user:bar@gmail.com"
576 # ]
577 # }
578 # ]
579 # }
580 # ]
581 # }
582 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
583 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
584 # bar@gmail.com from DATA_WRITE logging.
585 "auditLogConfigs": [ # The configuration for logging of each type of permission.
586 # Next ID: 4
587 { # Provides the configuration for logging a type of permissions.
588 # Example:
589 #
590 # {
591 # "audit_log_configs": [
592 # {
593 # "log_type": "DATA_READ",
594 # "exempted_members": [
595 # "user:foo@gmail.com"
596 # ]
597 # },
598 # {
599 # "log_type": "DATA_WRITE",
600 # }
601 # ]
602 # }
603 #
604 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
605 # foo@gmail.com from DATA_READ logging.
606 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
607 # permission.
608 # Follows the same format of Binding.members.
609 "A String",
610 ],
611 "logType": "A String", # The log type that this config enables.
612 },
613 ],
614 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700615 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400616 # `allServices` is a special value that covers all services.
617 },
618 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700619 }</pre>
620</div>
621
622<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000623 <code class="details" id="list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800624 <pre>Lists Projects that are visible to the user and satisfy the
625specified filter. This method returns Projects in an unspecified order.
626New Projects do not necessarily appear at the end of the list.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000627
628Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800629 pageSize: integer, The maximum number of Projects to return in the response.
630The server can return fewer Projects than requested.
631If unspecified, server picks an appropriate default.
632
633Optional.
634 filter: string, An expression for filtering the results of the request. Filter rules are
635case insensitive. The fields eligible for filtering are:
636
637+ `name`
638+ `id`
639+ <code>labels.<em>key</em></code> where *key* is the name of a label
640
641Some examples of using labels as filters:
642
643|Filter|Description|
644|------|-----------|
645|name:*|The project has a name.|
646|name:Howl|The project's name is `Howl` or `howl`.|
647|name:HOWL|Equivalent to above.|
648|NAME:howl|Equivalent to above.|
649|labels.color:*|The project has the label `color`.|
650|labels.color:red|The project's label `color` has the value `red`.|
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700651|labels.color:red&nbsp;labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800652
653Optional.
654 pageToken: string, A pagination token returned from a previous call to ListProjects
655that indicates from where listing should continue.
656
657Optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000658 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800659 Allowed values
660 1 - v1 error format
661 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000662
663Returns:
664 An object of the form:
665
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800666 { # A page of the response received from the
667 # ListProjects
668 # method.
669 #
670 # A paginated response where more pages are available has
671 # `next_page_token` set. This token can be used in a subsequent request to
672 # retrieve the next request page.
673 "nextPageToken": "A String", # Pagination token.
674 #
675 # If the result set is too large to fit in a single response, this token
676 # is returned. It encodes the position of the current result cursor.
677 # Feeding this value into a new list request with the `page_token` parameter
678 # gives the next page of the results.
679 #
680 # When `next_page_token` is not filled in, there is no next page and
681 # the list returned is the last page in the result set.
682 #
683 # Pagination tokens have a limited lifetime.
684 "projects": [ # The list of Projects that matched the list filter. This list can
685 # be paginated.
686 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400687 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800688 # Google Cloud Platform resources.
689 "name": "A String", # The user-assigned display name of the Project.
690 # It must be 4 to 30 characters.
691 # Allowed characters are: lowercase and uppercase letters, numbers,
692 # hyphen, single-quote, double-quote, space, and exclamation point.
693 #
694 # Example: <code>My Project</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800695 # Read-write.
696 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
697 #
698 # The only supported parent type is "organization". Once set, the parent
699 # cannot be modified. The `parent` can be set on creation or using the
700 # `UpdateProject` method; the end user must have the
701 # `resourcemanager.projects.create` permission on the parent.
702 #
703 # Read-write.
704 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400705 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800706 # a Compute Engine instance, a Cloud SQL database, and so on.
707 "type": "A String", # Required field representing the resource type this id is for.
708 # At present, the valid types are "project" and "organization".
709 "id": "A String", # Required field for the type-specific id. This should correspond to the id
710 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700711 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800712 "projectId": "A String", # The unique, user-assigned ID of the Project.
713 # It must be 6 to 30 lowercase letters, digits, or hyphens.
714 # It must start with a letter.
715 # Trailing hyphens are prohibited.
716 #
717 # Example: <code>tokyo-rain-123</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800718 # Read-only after creation.
719 "labels": { # The labels associated with this Project.
720 #
721 # Label keys must be between 1 and 63 characters long and must conform
722 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
723 #
724 # Label values must be between 0 and 63 characters long and must conform
725 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
726 #
727 # No more than 256 labels can be associated with a given resource.
728 #
729 # Clients should store labels in a representation such as JSON that does not
730 # depend on specific characters being disallowed.
731 #
732 # Example: <code>"environment" : "dev"</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800733 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000734 "a_key": "A String",
735 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700736 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800737 #
738 # Read-only.
739 "lifecycleState": "A String", # The Project lifecycle state.
740 #
741 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -0700742 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800743 #
Thomas Coffee2f245372017-03-27 10:39:26 -0700744 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800745 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000746 },
747 ],
748 }</pre>
749</div>
750
751<div class="method">
752 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
753 <pre>Retrieves the next page of results.
754
755Args:
756 previous_request: The request for the previous page. (required)
757 previous_response: The response from the request for the previous page. (required)
758
759Returns:
760 A request object that you can call 'execute()' on to request the next
761 page. Returns None if there are no more items in the collection.
762 </pre>
763</div>
764
765<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700766 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800767 <pre>Sets the IAM access control policy for the specified Project. Replaces
768any existing policy.
769
770The following constraints apply when using `setIamPolicy()`:
771
772+ Project does not support `allUsers` and `allAuthenticatedUsers` as
773`members` in a `Binding` of a `Policy`.
774
775+ The owner role can be granted only to `user` and `serviceAccount`.
776
777+ Service accounts can be made owners of a project directly
778without any restrictions. However, to be added as an owner, a user must be
779invited via Cloud Platform console and must accept the invitation.
780
781+ A user cannot be granted the owner role using `setIamPolicy()`. The user
782must be granted the owner role using the Cloud Platform Console and must
783explicitly accept the invitation.
784
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700785+ Invitations to grant the owner role cannot be sent using
786`setIamPolicy()`; they must be sent only using the Cloud Platform Console.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800787
788+ Membership changes that leave the project without any owners that have
789accepted the Terms of Service (ToS) will be rejected.
790
791+ There must be at least one owner who has accepted the Terms of
792Service (ToS) agreement in the policy. Calling `setIamPolicy()` to
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700793remove the last ToS-accepted owner from the policy will fail. This
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800794restriction also applies to legacy projects that no longer have owners
795who have accepted the ToS. Edits to IAM policies will be rejected until
796the lack of a ToS-accepting owner is rectified.
797
798+ Calling this method requires enabling the App Engine Admin API.
799
800Note: Removing service accounts from policies or changing their roles
801can render services completely inoperable. It is important to understand
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700802how the service account is being used before removing or updating its
803roles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700804
805Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800806 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400807See the operation documentation for the appropriate value for this field. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700808 body: object, The request body. (required)
809 The object takes the form of:
810
811{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800812 "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
813 # the policy is limited to a few 10s of KB. An empty policy is a
814 # valid policy but certain Cloud Platform services (such as Projects)
815 # might reject them.
816 # specify access control policies for Cloud Platform resources.
817 #
818 #
819 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
820 # `members` to a `role`, where the members can be user accounts, Google groups,
821 # Google domains, and service accounts. A `role` is a named list of permissions
822 # defined by IAM.
823 #
824 # **Example**
825 #
826 # {
827 # "bindings": [
828 # {
829 # "role": "roles/owner",
830 # "members": [
831 # "user:mike@example.com",
832 # "group:admins@example.com",
833 # "domain:google.com",
834 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
835 # ]
836 # },
837 # {
838 # "role": "roles/viewer",
839 # "members": ["user:sean@example.com"]
840 # }
841 # ]
842 # }
843 #
844 # For a description of IAM and its features, see the
845 # [IAM developer's guide](https://cloud.google.com/iam).
846 "bindings": [ # Associates a list of `members` to a `role`.
847 # Multiple `bindings` must not be specified for the same `role`.
848 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700849 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800850 "role": "A String", # Role that is assigned to `members`.
851 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
852 # Required
853 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
854 # `members` can have the following values:
855 #
856 # * `allUsers`: A special identifier that represents anyone who is
857 # on the internet; with or without a Google account.
858 #
859 # * `allAuthenticatedUsers`: A special identifier that represents anyone
860 # who is authenticated with a Google account or a service account.
861 #
862 # * `user:{emailid}`: An email address that represents a specific Google
863 # account. For example, `alice@gmail.com` or `joe@example.com`.
864 #
865 #
866 # * `serviceAccount:{emailid}`: An email address that represents a service
867 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
868 #
869 # * `group:{emailid}`: An email address that represents a Google group.
870 # For example, `admins@example.com`.
871 #
872 # * `domain:{domain}`: A Google Apps domain name that represents all the
873 # users of that domain. For example, `google.com` or `example.com`.
874 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700875 "A String",
876 ],
877 },
878 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700879 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
880 # prevent simultaneous updates of a policy from overwriting each other.
881 # It is strongly suggested that systems make use of the `etag` in the
882 # read-modify-write cycle to perform policy updates in order to avoid race
883 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
884 # systems are expected to put that etag in the request to `setIamPolicy` to
885 # ensure that their change will be applied to the same version of the policy.
886 #
887 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
888 # policy is overwritten blindly.
889 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400890 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
891 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700892 # The configuration determines which permission types are logged, and what
893 # identities, if any, are exempted from logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400894 # An AuditConifg must have one or more AuditLogConfigs.
895 #
896 # If there are AuditConfigs for both `allServices` and a specific service,
897 # the union of the two AuditConfigs is used for that service: the log_types
898 # specified in each AuditConfig are enabled, and the exempted_members in each
899 # AuditConfig are exempted.
900 # Example Policy with multiple AuditConfigs:
901 # {
902 # "audit_configs": [
903 # {
904 # "service": "allServices"
905 # "audit_log_configs": [
906 # {
907 # "log_type": "DATA_READ",
908 # "exempted_members": [
909 # "user:foo@gmail.com"
910 # ]
911 # },
912 # {
913 # "log_type": "DATA_WRITE",
914 # },
915 # {
916 # "log_type": "ADMIN_READ",
917 # }
918 # ]
919 # },
920 # {
921 # "service": "fooservice@googleapis.com"
922 # "audit_log_configs": [
923 # {
924 # "log_type": "DATA_READ",
925 # },
926 # {
927 # "log_type": "DATA_WRITE",
928 # "exempted_members": [
929 # "user:bar@gmail.com"
930 # ]
931 # }
932 # ]
933 # }
934 # ]
935 # }
936 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
937 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
938 # bar@gmail.com from DATA_WRITE logging.
939 "auditLogConfigs": [ # The configuration for logging of each type of permission.
940 # Next ID: 4
941 { # Provides the configuration for logging a type of permissions.
942 # Example:
943 #
944 # {
945 # "audit_log_configs": [
946 # {
947 # "log_type": "DATA_READ",
948 # "exempted_members": [
949 # "user:foo@gmail.com"
950 # ]
951 # },
952 # {
953 # "log_type": "DATA_WRITE",
954 # }
955 # ]
956 # }
957 #
958 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
959 # foo@gmail.com from DATA_READ logging.
960 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
961 # permission.
962 # Follows the same format of Binding.members.
963 "A String",
964 ],
965 "logType": "A String", # The log type that this config enables.
966 },
967 ],
968 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700969 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400970 # `allServices` is a special value that covers all services.
971 },
972 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700973 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400974 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700975 # the fields in the mask will be modified. If no mask is provided, the
976 # following default mask is used:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400977 # paths: "bindings, etag"
978 # This field is only used by Cloud IAM.
Takashi Matsuo06694102015-09-11 13:55:40 -0700979 }
980
981 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800982 Allowed values
983 1 - v1 error format
984 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700985
986Returns:
987 An object of the form:
988
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800989 { # Defines an Identity and Access Management (IAM) policy. It is used to
990 # specify access control policies for Cloud Platform resources.
991 #
992 #
993 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
994 # `members` to a `role`, where the members can be user accounts, Google groups,
995 # Google domains, and service accounts. A `role` is a named list of permissions
996 # defined by IAM.
997 #
998 # **Example**
999 #
1000 # {
1001 # "bindings": [
1002 # {
1003 # "role": "roles/owner",
1004 # "members": [
1005 # "user:mike@example.com",
1006 # "group:admins@example.com",
1007 # "domain:google.com",
1008 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
1009 # ]
1010 # },
1011 # {
1012 # "role": "roles/viewer",
1013 # "members": ["user:sean@example.com"]
1014 # }
1015 # ]
1016 # }
1017 #
1018 # For a description of IAM and its features, see the
1019 # [IAM developer's guide](https://cloud.google.com/iam).
1020 "bindings": [ # Associates a list of `members` to a `role`.
1021 # Multiple `bindings` must not be specified for the same `role`.
1022 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -07001023 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001024 "role": "A String", # Role that is assigned to `members`.
1025 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1026 # Required
1027 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1028 # `members` can have the following values:
1029 #
1030 # * `allUsers`: A special identifier that represents anyone who is
1031 # on the internet; with or without a Google account.
1032 #
1033 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1034 # who is authenticated with a Google account or a service account.
1035 #
1036 # * `user:{emailid}`: An email address that represents a specific Google
1037 # account. For example, `alice@gmail.com` or `joe@example.com`.
1038 #
1039 #
1040 # * `serviceAccount:{emailid}`: An email address that represents a service
1041 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1042 #
1043 # * `group:{emailid}`: An email address that represents a Google group.
1044 # For example, `admins@example.com`.
1045 #
1046 # * `domain:{domain}`: A Google Apps domain name that represents all the
1047 # users of that domain. For example, `google.com` or `example.com`.
1048 #
Takashi Matsuo06694102015-09-11 13:55:40 -07001049 "A String",
1050 ],
1051 },
1052 ],
Thomas Coffee2f245372017-03-27 10:39:26 -07001053 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1054 # prevent simultaneous updates of a policy from overwriting each other.
1055 # It is strongly suggested that systems make use of the `etag` in the
1056 # read-modify-write cycle to perform policy updates in order to avoid race
1057 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1058 # systems are expected to put that etag in the request to `setIamPolicy` to
1059 # ensure that their change will be applied to the same version of the policy.
1060 #
1061 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1062 # policy is overwritten blindly.
1063 "version": 42, # Version of the `Policy`. The default version is 0.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001064 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1065 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001066 # The configuration determines which permission types are logged, and what
1067 # identities, if any, are exempted from logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001068 # An AuditConifg must have one or more AuditLogConfigs.
1069 #
1070 # If there are AuditConfigs for both `allServices` and a specific service,
1071 # the union of the two AuditConfigs is used for that service: the log_types
1072 # specified in each AuditConfig are enabled, and the exempted_members in each
1073 # AuditConfig are exempted.
1074 # Example Policy with multiple AuditConfigs:
1075 # {
1076 # "audit_configs": [
1077 # {
1078 # "service": "allServices"
1079 # "audit_log_configs": [
1080 # {
1081 # "log_type": "DATA_READ",
1082 # "exempted_members": [
1083 # "user:foo@gmail.com"
1084 # ]
1085 # },
1086 # {
1087 # "log_type": "DATA_WRITE",
1088 # },
1089 # {
1090 # "log_type": "ADMIN_READ",
1091 # }
1092 # ]
1093 # },
1094 # {
1095 # "service": "fooservice@googleapis.com"
1096 # "audit_log_configs": [
1097 # {
1098 # "log_type": "DATA_READ",
1099 # },
1100 # {
1101 # "log_type": "DATA_WRITE",
1102 # "exempted_members": [
1103 # "user:bar@gmail.com"
1104 # ]
1105 # }
1106 # ]
1107 # }
1108 # ]
1109 # }
1110 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1111 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1112 # bar@gmail.com from DATA_WRITE logging.
1113 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1114 # Next ID: 4
1115 { # Provides the configuration for logging a type of permissions.
1116 # Example:
1117 #
1118 # {
1119 # "audit_log_configs": [
1120 # {
1121 # "log_type": "DATA_READ",
1122 # "exempted_members": [
1123 # "user:foo@gmail.com"
1124 # ]
1125 # },
1126 # {
1127 # "log_type": "DATA_WRITE",
1128 # }
1129 # ]
1130 # }
1131 #
1132 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1133 # foo@gmail.com from DATA_READ logging.
1134 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1135 # permission.
1136 # Follows the same format of Binding.members.
1137 "A String",
1138 ],
1139 "logType": "A String", # The log type that this config enables.
1140 },
1141 ],
1142 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -07001143 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001144 # `allServices` is a special value that covers all services.
1145 },
1146 ],
Takashi Matsuo06694102015-09-11 13:55:40 -07001147 }</pre>
1148</div>
1149
1150<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07001151 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001152 <pre>Returns permissions that a caller has on the specified Project.
Takashi Matsuo06694102015-09-11 13:55:40 -07001153
1154Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001155 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001156See the operation documentation for the appropriate value for this field. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -07001157 body: object, The request body. (required)
1158 The object takes the form of:
1159
1160{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001161 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1162 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1163 # information see
1164 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Takashi Matsuo06694102015-09-11 13:55:40 -07001165 "A String",
1166 ],
1167 }
1168
1169 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001170 Allowed values
1171 1 - v1 error format
1172 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -07001173
1174Returns:
1175 An object of the form:
1176
1177 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001178 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1179 # allowed.
Takashi Matsuo06694102015-09-11 13:55:40 -07001180 "A String",
1181 ],
1182 }</pre>
1183</div>
1184
1185<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07001186 <code class="details" id="undelete">undelete(projectId, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001187 <pre>Restores the Project identified by the specified
1188`project_id` (for example, `my-project-123`).
1189You can only use this method for a Project that has a lifecycle state of
1190DELETE_REQUESTED.
1191After deletion starts, the Project cannot be restored.
1192
1193The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001194
1195Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001196 projectId: string, The project ID (for example, `foo-bar-123`).
1197
1198Required. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001199 body: object, The request body. (required)
1200 The object takes the form of:
1201
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001202{ # The request sent to the UndeleteProject
1203 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -07001204 }
1205
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001206 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001207 Allowed values
1208 1 - v1 error format
1209 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001210
1211Returns:
1212 An object of the form:
1213
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001214 { # A generic empty message that you can re-use to avoid defining duplicated
1215 # empty messages in your APIs. A typical example is to use it as the request
1216 # or the response type of an API method. For instance:
1217 #
1218 # service Foo {
1219 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1220 # }
1221 #
1222 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001223 }</pre>
1224</div>
1225
1226<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -07001227 <code class="details" id="update">update(projectId, body, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001228 <pre>Updates the attributes of the Project identified by the specified
1229`project_id` (for example, `my-project-123`).
1230
1231The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001232
1233Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001234 projectId: string, The project ID (for example, `my-project-123`).
1235
1236Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001237 body: object, The request body. (required)
1238 The object takes the form of:
1239
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001240{ # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001241 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001242 # Google Cloud Platform resources.
1243 "name": "A String", # The user-assigned display name of the Project.
1244 # It must be 4 to 30 characters.
1245 # Allowed characters are: lowercase and uppercase letters, numbers,
1246 # hyphen, single-quote, double-quote, space, and exclamation point.
1247 #
1248 # Example: <code>My Project</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001249 # Read-write.
1250 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1251 #
1252 # The only supported parent type is "organization". Once set, the parent
1253 # cannot be modified. The `parent` can be set on creation or using the
1254 # `UpdateProject` method; the end user must have the
1255 # `resourcemanager.projects.create` permission on the parent.
1256 #
1257 # Read-write.
1258 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001259 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001260 # a Compute Engine instance, a Cloud SQL database, and so on.
1261 "type": "A String", # Required field representing the resource type this id is for.
1262 # At present, the valid types are "project" and "organization".
1263 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1264 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -07001265 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001266 "projectId": "A String", # The unique, user-assigned ID of the Project.
1267 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1268 # It must start with a letter.
1269 # Trailing hyphens are prohibited.
1270 #
1271 # Example: <code>tokyo-rain-123</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001272 # Read-only after creation.
1273 "labels": { # The labels associated with this Project.
1274 #
1275 # Label keys must be between 1 and 63 characters long and must conform
1276 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1277 #
1278 # Label values must be between 0 and 63 characters long and must conform
1279 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1280 #
1281 # No more than 256 labels can be associated with a given resource.
1282 #
1283 # Clients should store labels in a representation such as JSON that does not
1284 # depend on specific characters being disallowed.
1285 #
1286 # Example: <code>"environment" : "dev"</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001287 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001288 "a_key": "A String",
1289 },
Thomas Coffee2f245372017-03-27 10:39:26 -07001290 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001291 #
1292 # Read-only.
1293 "lifecycleState": "A String", # The Project lifecycle state.
1294 #
1295 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -07001296 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001297 #
Thomas Coffee2f245372017-03-27 10:39:26 -07001298 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001299 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001300}
1301
1302 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001303 Allowed values
1304 1 - v1 error format
1305 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001306
1307Returns:
1308 An object of the form:
1309
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001310 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001311 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001312 # Google Cloud Platform resources.
1313 "name": "A String", # The user-assigned display name of the Project.
1314 # It must be 4 to 30 characters.
1315 # Allowed characters are: lowercase and uppercase letters, numbers,
1316 # hyphen, single-quote, double-quote, space, and exclamation point.
1317 #
1318 # Example: <code>My Project</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001319 # Read-write.
1320 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1321 #
1322 # The only supported parent type is "organization". Once set, the parent
1323 # cannot be modified. The `parent` can be set on creation or using the
1324 # `UpdateProject` method; the end user must have the
1325 # `resourcemanager.projects.create` permission on the parent.
1326 #
1327 # Read-write.
1328 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -04001329 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001330 # a Compute Engine instance, a Cloud SQL database, and so on.
1331 "type": "A String", # Required field representing the resource type this id is for.
1332 # At present, the valid types are "project" and "organization".
1333 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1334 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -07001335 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001336 "projectId": "A String", # The unique, user-assigned ID of the Project.
1337 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1338 # It must start with a letter.
1339 # Trailing hyphens are prohibited.
1340 #
1341 # Example: <code>tokyo-rain-123</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001342 # Read-only after creation.
1343 "labels": { # The labels associated with this Project.
1344 #
1345 # Label keys must be between 1 and 63 characters long and must conform
1346 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1347 #
1348 # Label values must be between 0 and 63 characters long and must conform
1349 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1350 #
1351 # No more than 256 labels can be associated with a given resource.
1352 #
1353 # Clients should store labels in a representation such as JSON that does not
1354 # depend on specific characters being disallowed.
1355 #
1356 # Example: <code>"environment" : "dev"</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001357 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001358 "a_key": "A String",
1359 },
Thomas Coffee2f245372017-03-27 10:39:26 -07001360 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001361 #
1362 # Read-only.
1363 "lifecycleState": "A String", # The Project lifecycle state.
1364 #
1365 # Read-only.
Thomas Coffee2f245372017-03-27 10:39:26 -07001366 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001367 #
Thomas Coffee2f245372017-03-27 10:39:26 -07001368 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -08001369 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +00001370 }</pre>
1371</div>
1372
1373</body></html>