Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: 96b2efc50cca46f9454d00e6aba0fbadbcb4890b [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudresourcemanager_v1beta1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]78 <code><a href="#create">create(body, useLegacyStack=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]79<p class="firstline">Creates a Project resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]81 <code><a href="#delete">delete(projectId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Marks the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]84 <code><a href="#get">get(projectId=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]87 <code><a href="#getAncestry">getAncestry(projectId=None, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]90 <code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]93 <code><a href="#list">list(pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94<p class="firstline">Lists Projects that are visible to the user and satisfy the</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]99 <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
100<p class="firstline">Sets the IAM access control policy for the specified Project. Replaces</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]102 <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]105 <code><a href="#undelete">undelete(projectId=None, body, x__xgafv=None)</a></code></p>
106<p class="firstline">Restores the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108 <code><a href="#update">update(projectId=None, body, x__xgafv=None)</a></code></p>
109<p class="firstline">Updates the attributes of the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]112 <code class="details" id="create">create(body, useLegacyStack=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 <pre>Creates a Project resource.
114
115Initially, the Project resource is owned by its creator exclusively.
116The creator can later grant permission to others to read or update the
117Project.
118
119Several APIs are activated automatically for the Project, including
120Google Cloud Storage.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]121
122Args:
123 body: object, The request body. (required)
124 The object takes the form of:
125
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]126{ # A Project is a high-level Google Cloud Platform entity. It is a
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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]261 <code class="details" id="delete">delete(projectId=None, x__xgafv=None)</code>
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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]312 <code class="details" id="get">get(projectId=None, x__xgafv=None)</code>
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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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 Cheemalapatic30d2b52017-03-13 12:12:03 -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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]394 <code class="details" id="getAncestry">getAncestry(projectId=None, body, x__xgafv=None)</code>
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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]440 <code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code>
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 #
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 -0700[diff] [blame]521 "A String",
522 ],
523 },
524 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]525 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
526 { # Specifies the audit configuration for a service.
527 # It consists of which permission types are logged, and what identities, if
528 # any, are exempted from logging.
529 # An AuditConifg must have one or more AuditLogConfigs.
530 #
531 # If there are AuditConfigs for both `allServices` and a specific service,
532 # the union of the two AuditConfigs is used for that service: the log_types
533 # specified in each AuditConfig are enabled, and the exempted_members in each
534 # AuditConfig are exempted.
535 # Example Policy with multiple AuditConfigs:
536 # {
537 # "audit_configs": [
538 # {
539 # "service": "allServices"
540 # "audit_log_configs": [
541 # {
542 # "log_type": "DATA_READ",
543 # "exempted_members": [
544 # "user:foo@gmail.com"
545 # ]
546 # },
547 # {
548 # "log_type": "DATA_WRITE",
549 # },
550 # {
551 # "log_type": "ADMIN_READ",
552 # }
553 # ]
554 # },
555 # {
556 # "service": "fooservice@googleapis.com"
557 # "audit_log_configs": [
558 # {
559 # "log_type": "DATA_READ",
560 # },
561 # {
562 # "log_type": "DATA_WRITE",
563 # "exempted_members": [
564 # "user:bar@gmail.com"
565 # ]
566 # }
567 # ]
568 # }
569 # ]
570 # }
571 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
572 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
573 # bar@gmail.com from DATA_WRITE logging.
574 "auditLogConfigs": [ # The configuration for logging of each type of permission.
575 # Next ID: 4
576 { # Provides the configuration for logging a type of permissions.
577 # Example:
578 #
579 # {
580 # "audit_log_configs": [
581 # {
582 # "log_type": "DATA_READ",
583 # "exempted_members": [
584 # "user:foo@gmail.com"
585 # ]
586 # },
587 # {
588 # "log_type": "DATA_WRITE",
589 # }
590 # ]
591 # }
592 #
593 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
594 # foo@gmail.com from DATA_READ logging.
595 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
596 # permission.
597 # Follows the same format of Binding.members.
598 "A String",
599 ],
600 "logType": "A String", # The log type that this config enables.
601 },
602 ],
603 "service": "A String", # Specifies a service that will be enabled for audit logging.
604 # For example, `resourcemanager`, `storage`, `compute`.
605 # `allServices` is a special value that covers all services.
606 },
607 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]608 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
609 # prevent simultaneous updates of a policy from overwriting each other.
610 # It is strongly suggested that systems make use of the `etag` in the
611 # read-modify-write cycle to perform policy updates in order to avoid race
612 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
613 # systems are expected to put that etag in the request to `setIamPolicy` to
614 # ensure that their change will be applied to the same version of the policy.
615 #
616 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
617 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]618 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]619 }</pre>
620</div>
621
622<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]623 <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]624 <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 +0000[diff] [blame]627
628Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]629 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`.|
651|labels.color:red&nbsp;label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.
652
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 +0000[diff] [blame]658 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]659 Allowed values
660 1 - v1 error format
661 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]662
663Returns:
664 An object of the form:
665
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]666 { # 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 -0400[diff] [blame^]687 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]688 # 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 -0800[diff] [blame]695 # 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 -0400[diff] [blame^]705 # 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]706 # 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 -0700[diff] [blame]711 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]712 "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 -0800[diff] [blame]718 # 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 -0800[diff] [blame]733 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]734 "a_key": "A String",
735 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]736 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]737 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]738 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]739 # Read-only.
740 "lifecycleState": "A String", # The Project lifecycle state.
741 #
742 # Read-only.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]743 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]744 #
745 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]746 },
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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]766 <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
767 <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
785+ Invitations to grant the owner role cannot be sent using `setIamPolicy()`;
786they must be sent only using the Cloud Platform Console.
787
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
793to remove the last ToS-accepted owner from the policy will fail. This
794restriction 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
802how the service account is being used before removing or updating its roles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]803
804Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]805 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]806See the operation documentation for the appropriate value for this field. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]807 body: object, The request body. (required)
808 The object takes the form of:
809
810{ # Request message for `SetIamPolicy` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]811 "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
812 # the policy is limited to a few 10s of KB. An empty policy is a
813 # valid policy but certain Cloud Platform services (such as Projects)
814 # might reject them.
815 # specify access control policies for Cloud Platform resources.
816 #
817 #
818 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
819 # `members` to a `role`, where the members can be user accounts, Google groups,
820 # Google domains, and service accounts. A `role` is a named list of permissions
821 # defined by IAM.
822 #
823 # **Example**
824 #
825 # {
826 # "bindings": [
827 # {
828 # "role": "roles/owner",
829 # "members": [
830 # "user:mike@example.com",
831 # "group:admins@example.com",
832 # "domain:google.com",
833 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
834 # ]
835 # },
836 # {
837 # "role": "roles/viewer",
838 # "members": ["user:sean@example.com"]
839 # }
840 # ]
841 # }
842 #
843 # For a description of IAM and its features, see the
844 # [IAM developer's guide](https://cloud.google.com/iam).
845 "bindings": [ # Associates a list of `members` to a `role`.
846 # Multiple `bindings` must not be specified for the same `role`.
847 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]848 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]849 "role": "A String", # Role that is assigned to `members`.
850 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
851 # Required
852 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
853 # `members` can have the following values:
854 #
855 # * `allUsers`: A special identifier that represents anyone who is
856 # on the internet; with or without a Google account.
857 #
858 # * `allAuthenticatedUsers`: A special identifier that represents anyone
859 # who is authenticated with a Google account or a service account.
860 #
861 # * `user:{emailid}`: An email address that represents a specific Google
862 # account. For example, `alice@gmail.com` or `joe@example.com`.
863 #
864 #
865 # * `serviceAccount:{emailid}`: An email address that represents a service
866 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
867 #
868 # * `group:{emailid}`: An email address that represents a Google group.
869 # For example, `admins@example.com`.
870 #
871 # * `domain:{domain}`: A Google Apps domain name that represents all the
872 # users of that domain. For example, `google.com` or `example.com`.
873 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]874 "A String",
875 ],
876 },
877 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]878 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
879 { # Specifies the audit configuration for a service.
880 # It consists of which permission types are logged, and what identities, if
881 # any, are exempted from logging.
882 # An AuditConifg must have one or more AuditLogConfigs.
883 #
884 # If there are AuditConfigs for both `allServices` and a specific service,
885 # the union of the two AuditConfigs is used for that service: the log_types
886 # specified in each AuditConfig are enabled, and the exempted_members in each
887 # AuditConfig are exempted.
888 # Example Policy with multiple AuditConfigs:
889 # {
890 # "audit_configs": [
891 # {
892 # "service": "allServices"
893 # "audit_log_configs": [
894 # {
895 # "log_type": "DATA_READ",
896 # "exempted_members": [
897 # "user:foo@gmail.com"
898 # ]
899 # },
900 # {
901 # "log_type": "DATA_WRITE",
902 # },
903 # {
904 # "log_type": "ADMIN_READ",
905 # }
906 # ]
907 # },
908 # {
909 # "service": "fooservice@googleapis.com"
910 # "audit_log_configs": [
911 # {
912 # "log_type": "DATA_READ",
913 # },
914 # {
915 # "log_type": "DATA_WRITE",
916 # "exempted_members": [
917 # "user:bar@gmail.com"
918 # ]
919 # }
920 # ]
921 # }
922 # ]
923 # }
924 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
925 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
926 # bar@gmail.com from DATA_WRITE logging.
927 "auditLogConfigs": [ # The configuration for logging of each type of permission.
928 # Next ID: 4
929 { # Provides the configuration for logging a type of permissions.
930 # Example:
931 #
932 # {
933 # "audit_log_configs": [
934 # {
935 # "log_type": "DATA_READ",
936 # "exempted_members": [
937 # "user:foo@gmail.com"
938 # ]
939 # },
940 # {
941 # "log_type": "DATA_WRITE",
942 # }
943 # ]
944 # }
945 #
946 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
947 # foo@gmail.com from DATA_READ logging.
948 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
949 # permission.
950 # Follows the same format of Binding.members.
951 "A String",
952 ],
953 "logType": "A String", # The log type that this config enables.
954 },
955 ],
956 "service": "A String", # Specifies a service that will be enabled for audit logging.
957 # For example, `resourcemanager`, `storage`, `compute`.
958 # `allServices` is a special value that covers all services.
959 },
960 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]961 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
962 # prevent simultaneous updates of a policy from overwriting each other.
963 # It is strongly suggested that systems make use of the `etag` in the
964 # read-modify-write cycle to perform policy updates in order to avoid race
965 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
966 # systems are expected to put that etag in the request to `setIamPolicy` to
967 # ensure that their change will be applied to the same version of the policy.
968 #
969 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
970 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]971 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]972 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]973 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
974 # the fields in the mask will be modified. If no mask is provided, a default
975 # mask is used:
976 # paths: "bindings, etag"
977 # This field is only used by Cloud IAM.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]978 }
979
980 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]981 Allowed values
982 1 - v1 error format
983 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]984
985Returns:
986 An object of the form:
987
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]988 { # Defines an Identity and Access Management (IAM) policy. It is used to
989 # specify access control policies for Cloud Platform resources.
990 #
991 #
992 # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
993 # `members` to a `role`, where the members can be user accounts, Google groups,
994 # Google domains, and service accounts. A `role` is a named list of permissions
995 # defined by IAM.
996 #
997 # **Example**
998 #
999 # {
1000 # "bindings": [
1001 # {
1002 # "role": "roles/owner",
1003 # "members": [
1004 # "user:mike@example.com",
1005 # "group:admins@example.com",
1006 # "domain:google.com",
1007 # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
1008 # ]
1009 # },
1010 # {
1011 # "role": "roles/viewer",
1012 # "members": ["user:sean@example.com"]
1013 # }
1014 # ]
1015 # }
1016 #
1017 # For a description of IAM and its features, see the
1018 # [IAM developer's guide](https://cloud.google.com/iam).
1019 "bindings": [ # Associates a list of `members` to a `role`.
1020 # Multiple `bindings` must not be specified for the same `role`.
1021 # `bindings` with no members will result in an error.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1022 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1023 "role": "A String", # Role that is assigned to `members`.
1024 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1025 # Required
1026 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1027 # `members` can have the following values:
1028 #
1029 # * `allUsers`: A special identifier that represents anyone who is
1030 # on the internet; with or without a Google account.
1031 #
1032 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1033 # who is authenticated with a Google account or a service account.
1034 #
1035 # * `user:{emailid}`: An email address that represents a specific Google
1036 # account. For example, `alice@gmail.com` or `joe@example.com`.
1037 #
1038 #
1039 # * `serviceAccount:{emailid}`: An email address that represents a service
1040 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1041 #
1042 # * `group:{emailid}`: An email address that represents a Google group.
1043 # For example, `admins@example.com`.
1044 #
1045 # * `domain:{domain}`: A Google Apps domain name that represents all the
1046 # users of that domain. For example, `google.com` or `example.com`.
1047 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1048 "A String",
1049 ],
1050 },
1051 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1052 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1053 { # Specifies the audit configuration for a service.
1054 # It consists of which permission types are logged, and what identities, if
1055 # any, are exempted from logging.
1056 # An AuditConifg must have one or more AuditLogConfigs.
1057 #
1058 # If there are AuditConfigs for both `allServices` and a specific service,
1059 # the union of the two AuditConfigs is used for that service: the log_types
1060 # specified in each AuditConfig are enabled, and the exempted_members in each
1061 # AuditConfig are exempted.
1062 # Example Policy with multiple AuditConfigs:
1063 # {
1064 # "audit_configs": [
1065 # {
1066 # "service": "allServices"
1067 # "audit_log_configs": [
1068 # {
1069 # "log_type": "DATA_READ",
1070 # "exempted_members": [
1071 # "user:foo@gmail.com"
1072 # ]
1073 # },
1074 # {
1075 # "log_type": "DATA_WRITE",
1076 # },
1077 # {
1078 # "log_type": "ADMIN_READ",
1079 # }
1080 # ]
1081 # },
1082 # {
1083 # "service": "fooservice@googleapis.com"
1084 # "audit_log_configs": [
1085 # {
1086 # "log_type": "DATA_READ",
1087 # },
1088 # {
1089 # "log_type": "DATA_WRITE",
1090 # "exempted_members": [
1091 # "user:bar@gmail.com"
1092 # ]
1093 # }
1094 # ]
1095 # }
1096 # ]
1097 # }
1098 # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1099 # logging. It also exempts foo@gmail.com from DATA_READ logging, and
1100 # bar@gmail.com from DATA_WRITE logging.
1101 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1102 # Next ID: 4
1103 { # Provides the configuration for logging a type of permissions.
1104 # Example:
1105 #
1106 # {
1107 # "audit_log_configs": [
1108 # {
1109 # "log_type": "DATA_READ",
1110 # "exempted_members": [
1111 # "user:foo@gmail.com"
1112 # ]
1113 # },
1114 # {
1115 # "log_type": "DATA_WRITE",
1116 # }
1117 # ]
1118 # }
1119 #
1120 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
1121 # foo@gmail.com from DATA_READ logging.
1122 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1123 # permission.
1124 # Follows the same format of Binding.members.
1125 "A String",
1126 ],
1127 "logType": "A String", # The log type that this config enables.
1128 },
1129 ],
1130 "service": "A String", # Specifies a service that will be enabled for audit logging.
1131 # For example, `resourcemanager`, `storage`, `compute`.
1132 # `allServices` is a special value that covers all services.
1133 },
1134 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1135 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1136 # prevent simultaneous updates of a policy from overwriting each other.
1137 # It is strongly suggested that systems make use of the `etag` in the
1138 # read-modify-write cycle to perform policy updates in order to avoid race
1139 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1140 # systems are expected to put that etag in the request to `setIamPolicy` to
1141 # ensure that their change will be applied to the same version of the policy.
1142 #
1143 # If no `etag` is provided in the call to `setIamPolicy`, then the existing
1144 # policy is overwritten blindly.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1145 "version": 42, # Version of the `Policy`. The default version is 0.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1146 }</pre>
1147</div>
1148
1149<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1150 <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1151 <pre>Returns permissions that a caller has on the specified Project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1152
1153Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1154 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1155See the operation documentation for the appropriate value for this field. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1156 body: object, The request body. (required)
1157 The object takes the form of:
1158
1159{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1160 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1161 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1162 # information see
1163 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1164 "A String",
1165 ],
1166 }
1167
1168 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1169 Allowed values
1170 1 - v1 error format
1171 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1172
1173Returns:
1174 An object of the form:
1175
1176 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1177 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1178 # allowed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1179 "A String",
1180 ],
1181 }</pre>
1182</div>
1183
1184<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1185 <code class="details" id="undelete">undelete(projectId=None, body, x__xgafv=None)</code>
1186 <pre>Restores the Project identified by the specified
1187`project_id` (for example, `my-project-123`).
1188You can only use this method for a Project that has a lifecycle state of
1189DELETE_REQUESTED.
1190After deletion starts, the Project cannot be restored.
1191
1192The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1193
1194Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1195 projectId: string, The project ID (for example, `foo-bar-123`).
1196
1197Required. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1198 body: object, The request body. (required)
1199 The object takes the form of:
1200
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1201{ # The request sent to the UndeleteProject
1202 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1203 }
1204
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1205 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1206 Allowed values
1207 1 - v1 error format
1208 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1209
1210Returns:
1211 An object of the form:
1212
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1213 { # A generic empty message that you can re-use to avoid defining duplicated
1214 # empty messages in your APIs. A typical example is to use it as the request
1215 # or the response type of an API method. For instance:
1216 #
1217 # service Foo {
1218 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1219 # }
1220 #
1221 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1222 }</pre>
1223</div>
1224
1225<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1226 <code class="details" id="update">update(projectId=None, body, x__xgafv=None)</code>
1227 <pre>Updates the attributes of the Project identified by the specified
1228`project_id` (for example, `my-project-123`).
1229
1230The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1231
1232Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1233 projectId: string, The project ID (for example, `my-project-123`).
1234
1235Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1236 body: object, The request body. (required)
1237 The object takes the form of:
1238
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1239{ # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1240 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1241 # Google Cloud Platform resources.
1242 "name": "A String", # The user-assigned display name of the Project.
1243 # It must be 4 to 30 characters.
1244 # Allowed characters are: lowercase and uppercase letters, numbers,
1245 # hyphen, single-quote, double-quote, space, and exclamation point.
1246 #
1247 # Example: <code>My Project</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1248 # Read-write.
1249 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1250 #
1251 # The only supported parent type is "organization". Once set, the parent
1252 # cannot be modified. The `parent` can be set on creation or using the
1253 # `UpdateProject` method; the end user must have the
1254 # `resourcemanager.projects.create` permission on the parent.
1255 #
1256 # Read-write.
1257 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1258 # 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]1259 # a Compute Engine instance, a Cloud SQL database, and so on.
1260 "type": "A String", # Required field representing the resource type this id is for.
1261 # At present, the valid types are "project" and "organization".
1262 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1263 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1264 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1265 "projectId": "A String", # The unique, user-assigned ID of the Project.
1266 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1267 # It must start with a letter.
1268 # Trailing hyphens are prohibited.
1269 #
1270 # Example: <code>tokyo-rain-123</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1271 # Read-only after creation.
1272 "labels": { # The labels associated with this Project.
1273 #
1274 # Label keys must be between 1 and 63 characters long and must conform
1275 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1276 #
1277 # Label values must be between 0 and 63 characters long and must conform
1278 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1279 #
1280 # No more than 256 labels can be associated with a given resource.
1281 #
1282 # Clients should store labels in a representation such as JSON that does not
1283 # depend on specific characters being disallowed.
1284 #
1285 # Example: <code>"environment" : "dev"</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1286 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1287 "a_key": "A String",
1288 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1289 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1290 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1291 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1292 # Read-only.
1293 "lifecycleState": "A String", # The Project lifecycle state.
1294 #
1295 # Read-only.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1296 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1297 #
1298 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1299}
1300
1301 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1302 Allowed values
1303 1 - v1 error format
1304 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1305
1306Returns:
1307 An object of the form:
1308
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1309 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1310 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1311 # Google Cloud Platform resources.
1312 "name": "A String", # The user-assigned display name of the Project.
1313 # It must be 4 to 30 characters.
1314 # Allowed characters are: lowercase and uppercase letters, numbers,
1315 # hyphen, single-quote, double-quote, space, and exclamation point.
1316 #
1317 # Example: <code>My Project</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1318 # Read-write.
1319 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1320 #
1321 # The only supported parent type is "organization". Once set, the parent
1322 # cannot be modified. The `parent` can be set on creation or using the
1323 # `UpdateProject` method; the end user must have the
1324 # `resourcemanager.projects.create` permission on the parent.
1325 #
1326 # Read-write.
1327 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1328 # 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]1329 # a Compute Engine instance, a Cloud SQL database, and so on.
1330 "type": "A String", # Required field representing the resource type this id is for.
1331 # At present, the valid types are "project" and "organization".
1332 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1333 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1334 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1335 "projectId": "A String", # The unique, user-assigned ID of the Project.
1336 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1337 # It must start with a letter.
1338 # Trailing hyphens are prohibited.
1339 #
1340 # Example: <code>tokyo-rain-123</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1341 # Read-only after creation.
1342 "labels": { # The labels associated with this Project.
1343 #
1344 # Label keys must be between 1 and 63 characters long and must conform
1345 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1346 #
1347 # Label values must be between 0 and 63 characters long and must conform
1348 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?.
1349 #
1350 # No more than 256 labels can be associated with a given resource.
1351 #
1352 # Clients should store labels in a representation such as JSON that does not
1353 # depend on specific characters being disallowed.
1354 #
1355 # Example: <code>"environment" : "dev"</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1356 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1357 "a_key": "A String",
1358 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1359 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1360 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1361 # Example: <code>415104041262</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1362 # Read-only.
1363 "lifecycleState": "A String", # The Project lifecycle state.
1364 #
1365 # Read-only.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]1366 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1367 #
1368 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1369 }</pre>
1370</div>
1371
1372</body></html>