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