1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/appengine.admin": {
6 "description": "View and manage your applications deployed on Google App Engine"
7 },
8 "https://www.googleapis.com/auth/cloud-platform": {
9 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
10 },
11 "https://www.googleapis.com/auth/cloud-platform.read-only": {
12 "description": "View your data across Google Cloud services and see the email address of your Google Account"
13 }
14 }
15 }
16 },
17 "basePath": "",
18 "baseUrl": "https://appengine.googleapis.com/",
19 "batchPath": "batch",
20 "description": "Provisions and manages developers' App Engine applications.",
21 "discoveryVersion": "v1",
22 "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
23 "fullyEncodeReservedExpansion": true,
24 "icons": {
25 "x16": "http://www.google.com/images/icons/product/search-16.gif",
26 "x32": "http://www.google.com/images/icons/product/search-32.gif"
27 },
28 "id": "appengine:v1alpha",
29 "kind": "discovery#restDescription",
30 "mtlsRootUrl": "https://appengine.mtls.googleapis.com/",
31 "name": "appengine",
32 "ownerDomain": "google.com",
33 "ownerName": "Google",
34 "parameters": {
35 "$.xgafv": {
36 "description": "V1 error format.",
37 "enum": [
38 "1",
39 "2"
40 ],
41 "enumDescriptions": [
42 "v1 error format",
43 "v2 error format"
44 ],
45 "location": "query",
46 "type": "string"
47 },
48 "access_token": {
49 "description": "OAuth access token.",
50 "location": "query",
51 "type": "string"
52 },
53 "alt": {
54 "default": "json",
55 "description": "Data format for response.",
56 "enum": [
57 "json",
58 "media",
59 "proto"
60 ],
61 "enumDescriptions": [
62 "Responses with Content-Type of application/json",
63 "Media download with context-dependent Content-Type",
64 "Responses with Content-Type of application/x-protobuf"
65 ],
66 "location": "query",
67 "type": "string"
68 },
69 "callback": {
70 "description": "JSONP",
71 "location": "query",
72 "type": "string"
73 },
74 "fields": {
75 "description": "Selector specifying which fields to include in a partial response.",
76 "location": "query",
77 "type": "string"
78 },
79 "key": {
80 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
81 "location": "query",
82 "type": "string"
83 },
84 "oauth_token": {
85 "description": "OAuth 2.0 token for the current user.",
86 "location": "query",
87 "type": "string"
88 },
89 "prettyPrint": {
90 "default": "true",
91 "description": "Returns response with indentations and line breaks.",
92 "location": "query",
93 "type": "boolean"
94 },
95 "quotaUser": {
96 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
97 "location": "query",
98 "type": "string"
99 },
100 "uploadType": {
101 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 },
105 "upload_protocol": {
106 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
107 "location": "query",
108 "type": "string"
109 }
110 },
111 "protocol": "rest",
112 "resources": {
113 "apps": {
114 "resources": {
115 "authorizedCertificates": {
116 "methods": {
117 "create": {
118 "description": "Uploads the specified SSL certificate.",
119 "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
120 "httpMethod": "POST",
121 "id": "appengine.apps.authorizedCertificates.create",
122 "parameterOrder": [
123 "appsId"
124 ],
125 "parameters": {
126 "appsId": {
127 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
128 "location": "path",
129 "required": true,
130 "type": "string"
131 }
132 },
133 "path": "v1alpha/apps/{appsId}/authorizedCertificates",
134 "request": {
135 "$ref": "AuthorizedCertificate"
136 },
137 "response": {
138 "$ref": "AuthorizedCertificate"
139 },
140 "scopes": [
141 "https://www.googleapis.com/auth/cloud-platform"
142 ]
143 },
144 "delete": {
145 "description": "Deletes the specified SSL certificate.",
146 "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
147 "httpMethod": "DELETE",
148 "id": "appengine.apps.authorizedCertificates.delete",
149 "parameterOrder": [
150 "appsId",
151 "authorizedCertificatesId"
152 ],
153 "parameters": {
154 "appsId": {
155 "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.",
156 "location": "path",
157 "required": true,
158 "type": "string"
159 },
160 "authorizedCertificatesId": {
161 "description": "Part of `name`. See documentation of `appsId`.",
162 "location": "path",
163 "required": true,
164 "type": "string"
165 }
166 },
167 "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
168 "response": {
169 "$ref": "Empty"
170 },
171 "scopes": [
172 "https://www.googleapis.com/auth/cloud-platform"
173 ]
174 },
175 "get": {
176 "description": "Gets the specified SSL certificate.",
177 "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
178 "httpMethod": "GET",
179 "id": "appengine.apps.authorizedCertificates.get",
180 "parameterOrder": [
181 "appsId",
182 "authorizedCertificatesId"
183 ],
184 "parameters": {
185 "appsId": {
186 "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.",
187 "location": "path",
188 "required": true,
189 "type": "string"
190 },
191 "authorizedCertificatesId": {
192 "description": "Part of `name`. See documentation of `appsId`.",
193 "location": "path",
194 "required": true,
195 "type": "string"
196 },
197 "view": {
198 "description": "Controls the set of fields returned in the GET response.",
199 "enum": [
200 "BASIC_CERTIFICATE",
201 "FULL_CERTIFICATE"
202 ],
203 "enumDescriptions": [
204 "Basic certificate information, including applicable domains and expiration date.",
205 "The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped."
206 ],
207 "location": "query",
208 "type": "string"
209 }
210 },
211 "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
212 "response": {
213 "$ref": "AuthorizedCertificate"
214 },
215 "scopes": [
216 "https://www.googleapis.com/auth/appengine.admin",
217 "https://www.googleapis.com/auth/cloud-platform",
218 "https://www.googleapis.com/auth/cloud-platform.read-only"
219 ]
220 },
221 "list": {
222 "description": "Lists all SSL certificates the user is authorized to administer.",
223 "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates",
224 "httpMethod": "GET",
225 "id": "appengine.apps.authorizedCertificates.list",
226 "parameterOrder": [
227 "appsId"
228 ],
229 "parameters": {
230 "appsId": {
231 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
232 "location": "path",
233 "required": true,
234 "type": "string"
235 },
236 "pageSize": {
237 "description": "Maximum results to return per page.",
238 "format": "int32",
239 "location": "query",
240 "type": "integer"
241 },
242 "pageToken": {
243 "description": "Continuation token for fetching the next page of results.",
244 "location": "query",
245 "type": "string"
246 },
247 "view": {
248 "description": "Controls the set of fields returned in the LIST response.",
249 "enum": [
250 "BASIC_CERTIFICATE",
251 "FULL_CERTIFICATE"
252 ],
253 "enumDescriptions": [
254 "Basic certificate information, including applicable domains and expiration date.",
255 "The information from BASIC_CERTIFICATE, plus detailed information on the domain mappings that have this certificate mapped."
256 ],
257 "location": "query",
258 "type": "string"
259 }
260 },
261 "path": "v1alpha/apps/{appsId}/authorizedCertificates",
262 "response": {
263 "$ref": "ListAuthorizedCertificatesResponse"
264 },
265 "scopes": [
266 "https://www.googleapis.com/auth/appengine.admin",
267 "https://www.googleapis.com/auth/cloud-platform",
268 "https://www.googleapis.com/auth/cloud-platform.read-only"
269 ]
270 },
271 "patch": {
272 "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.",
273 "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
274 "httpMethod": "PATCH",
275 "id": "appengine.apps.authorizedCertificates.patch",
276 "parameterOrder": [
277 "appsId",
278 "authorizedCertificatesId"
279 ],
280 "parameters": {
281 "appsId": {
282 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.",
283 "location": "path",
284 "required": true,
285 "type": "string"
286 },
287 "authorizedCertificatesId": {
288 "description": "Part of `name`. See documentation of `appsId`.",
289 "location": "path",
290 "required": true,
291 "type": "string"
292 },
293 "updateMask": {
294 "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.",
295 "format": "google-fieldmask",
296 "location": "query",
297 "type": "string"
298 }
299 },
300 "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}",
301 "request": {
302 "$ref": "AuthorizedCertificate"
303 },
304 "response": {
305 "$ref": "AuthorizedCertificate"
306 },
307 "scopes": [
308 "https://www.googleapis.com/auth/cloud-platform"
309 ]
310 }
311 }
312 },
313 "authorizedDomains": {
314 "methods": {
315 "list": {
316 "description": "Lists all domains the user is authorized to administer.",
317 "flatPath": "v1alpha/apps/{appsId}/authorizedDomains",
318 "httpMethod": "GET",
319 "id": "appengine.apps.authorizedDomains.list",
320 "parameterOrder": [
321 "appsId"
322 ],
323 "parameters": {
324 "appsId": {
325 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
326 "location": "path",
327 "required": true,
328 "type": "string"
329 },
330 "pageSize": {
331 "description": "Maximum results to return per page.",
332 "format": "int32",
333 "location": "query",
334 "type": "integer"
335 },
336 "pageToken": {
337 "description": "Continuation token for fetching the next page of results.",
338 "location": "query",
339 "type": "string"
340 }
341 },
342 "path": "v1alpha/apps/{appsId}/authorizedDomains",
343 "response": {
344 "$ref": "ListAuthorizedDomainsResponse"
345 },
346 "scopes": [
347 "https://www.googleapis.com/auth/appengine.admin",
348 "https://www.googleapis.com/auth/cloud-platform",
349 "https://www.googleapis.com/auth/cloud-platform.read-only"
350 ]
351 }
352 }
353 },
354 "domainMappings": {
355 "methods": {
356 "create": {
357 "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.",
358 "flatPath": "v1alpha/apps/{appsId}/domainMappings",
359 "httpMethod": "POST",
360 "id": "appengine.apps.domainMappings.create",
361 "parameterOrder": [
362 "appsId"
363 ],
364 "parameters": {
365 "appsId": {
366 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
367 "location": "path",
368 "required": true,
369 "type": "string"
370 },
371 "noManagedCertificate": {
372 "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manaually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated.",
373 "location": "query",
374 "type": "boolean"
375 },
376 "overrideStrategy": {
377 "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.",
378 "enum": [
379 "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY",
380 "STRICT",
381 "OVERRIDE"
382 ],
383 "enumDescriptions": [
384 "Strategy unspecified. Defaults to STRICT.",
385 "Overrides not allowed. If a mapping already exists for the specified domain, the request will return an ALREADY_EXISTS (409).",
386 "Overrides allowed. If a mapping already exists for the specified domain, the request will overwrite it. Note that this might stop another Google product from serving. For example, if the domain is mapped to another App Engine application, that app will no longer serve from that domain."
387 ],
388 "location": "query",
389 "type": "string"
390 }
391 },
392 "path": "v1alpha/apps/{appsId}/domainMappings",
393 "request": {
394 "$ref": "DomainMapping"
395 },
396 "response": {
397 "$ref": "Operation"
398 },
399 "scopes": [
400 "https://www.googleapis.com/auth/cloud-platform"
401 ]
402 },
403 "delete": {
404 "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.",
405 "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
406 "httpMethod": "DELETE",
407 "id": "appengine.apps.domainMappings.delete",
408 "parameterOrder": [
409 "appsId",
410 "domainMappingsId"
411 ],
412 "parameters": {
413 "appsId": {
414 "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.",
415 "location": "path",
416 "required": true,
417 "type": "string"
418 },
419 "domainMappingsId": {
420 "description": "Part of `name`. See documentation of `appsId`.",
421 "location": "path",
422 "required": true,
423 "type": "string"
424 }
425 },
426 "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
427 "response": {
428 "$ref": "Operation"
429 },
430 "scopes": [
431 "https://www.googleapis.com/auth/cloud-platform"
432 ]
433 },
434 "get": {
435 "description": "Gets the specified domain mapping.",
436 "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
437 "httpMethod": "GET",
438 "id": "appengine.apps.domainMappings.get",
439 "parameterOrder": [
440 "appsId",
441 "domainMappingsId"
442 ],
443 "parameters": {
444 "appsId": {
445 "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.",
446 "location": "path",
447 "required": true,
448 "type": "string"
449 },
450 "domainMappingsId": {
451 "description": "Part of `name`. See documentation of `appsId`.",
452 "location": "path",
453 "required": true,
454 "type": "string"
455 }
456 },
457 "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
458 "response": {
459 "$ref": "DomainMapping"
460 },
461 "scopes": [
462 "https://www.googleapis.com/auth/appengine.admin",
463 "https://www.googleapis.com/auth/cloud-platform",
464 "https://www.googleapis.com/auth/cloud-platform.read-only"
465 ]
466 },
467 "list": {
468 "description": "Lists the domain mappings on an application.",
469 "flatPath": "v1alpha/apps/{appsId}/domainMappings",
470 "httpMethod": "GET",
471 "id": "appengine.apps.domainMappings.list",
472 "parameterOrder": [
473 "appsId"
474 ],
475 "parameters": {
476 "appsId": {
477 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
478 "location": "path",
479 "required": true,
480 "type": "string"
481 },
482 "pageSize": {
483 "description": "Maximum results to return per page.",
484 "format": "int32",
485 "location": "query",
486 "type": "integer"
487 },
488 "pageToken": {
489 "description": "Continuation token for fetching the next page of results.",
490 "location": "query",
491 "type": "string"
492 }
493 },
494 "path": "v1alpha/apps/{appsId}/domainMappings",
495 "response": {
496 "$ref": "ListDomainMappingsResponse"
497 },
498 "scopes": [
499 "https://www.googleapis.com/auth/appengine.admin",
500 "https://www.googleapis.com/auth/cloud-platform",
501 "https://www.googleapis.com/auth/cloud-platform.read-only"
502 ]
503 },
504 "patch": {
505 "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.",
506 "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
507 "httpMethod": "PATCH",
508 "id": "appengine.apps.domainMappings.patch",
509 "parameterOrder": [
510 "appsId",
511 "domainMappingsId"
512 ],
513 "parameters": {
514 "appsId": {
515 "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.",
516 "location": "path",
517 "required": true,
518 "type": "string"
519 },
520 "domainMappingsId": {
521 "description": "Part of `name`. See documentation of `appsId`.",
522 "location": "path",
523 "required": true,
524 "type": "string"
525 },
526 "noManagedCertificate": {
527 "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.",
528 "location": "query",
529 "type": "boolean"
530 },
531 "updateMask": {
532 "description": "Required. Standard field mask for the set of fields to be updated.",
533 "format": "google-fieldmask",
534 "location": "query",
535 "type": "string"
536 }
537 },
538 "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}",
539 "request": {
540 "$ref": "DomainMapping"
541 },
542 "response": {
543 "$ref": "Operation"
544 },
545 "scopes": [
546 "https://www.googleapis.com/auth/cloud-platform"
547 ]
548 }
549 }
550 },
551 "locations": {
552 "methods": {
553 "get": {
554 "description": "Gets information about a location.",
555 "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
556 "httpMethod": "GET",
557 "id": "appengine.apps.locations.get",
558 "parameterOrder": [
559 "appsId",
560 "locationsId"
561 ],
562 "parameters": {
563 "appsId": {
564 "description": "Part of `name`. Resource name for the location.",
565 "location": "path",
566 "required": true,
567 "type": "string"
568 },
569 "locationsId": {
570 "description": "Part of `name`. See documentation of `appsId`.",
571 "location": "path",
572 "required": true,
573 "type": "string"
574 }
575 },
576 "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
577 "response": {
578 "$ref": "Location"
579 },
580 "scopes": [
581 "https://www.googleapis.com/auth/appengine.admin",
582 "https://www.googleapis.com/auth/cloud-platform",
583 "https://www.googleapis.com/auth/cloud-platform.read-only"
584 ]
585 },
586 "list": {
587 "description": "Lists information about the supported locations for this service.",
588 "flatPath": "v1alpha/apps/{appsId}/locations",
589 "httpMethod": "GET",
590 "id": "appengine.apps.locations.list",
591 "parameterOrder": [
592 "appsId"
593 ],
594 "parameters": {
595 "appsId": {
596 "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
597 "location": "path",
598 "required": true,
599 "type": "string"
600 },
601 "filter": {
602 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in AIP-160 (https://google.aip.dev/160).",
603 "location": "query",
604 "type": "string"
605 },
606 "pageSize": {
607 "description": "The maximum number of results to return. If not set, the service selects a default.",
608 "format": "int32",
609 "location": "query",
610 "type": "integer"
611 },
612 "pageToken": {
613 "description": "A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.",
614 "location": "query",
615 "type": "string"
616 }
617 },
618 "path": "v1alpha/apps/{appsId}/locations",
619 "response": {
620 "$ref": "ListLocationsResponse"
621 },
622 "scopes": [
623 "https://www.googleapis.com/auth/appengine.admin",
624 "https://www.googleapis.com/auth/cloud-platform",
625 "https://www.googleapis.com/auth/cloud-platform.read-only"
626 ]
627 }
628 }
629 },
630 "operations": {
631 "methods": {
632 "get": {
633 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
634 "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
635 "httpMethod": "GET",
636 "id": "appengine.apps.operations.get",
637 "parameterOrder": [
638 "appsId",
639 "operationsId"
640 ],
641 "parameters": {
642 "appsId": {
643 "description": "Part of `name`. The name of the operation resource.",
644 "location": "path",
645 "required": true,
646 "type": "string"
647 },
648 "operationsId": {
649 "description": "Part of `name`. See documentation of `appsId`.",
650 "location": "path",
651 "required": true,
652 "type": "string"
653 }
654 },
655 "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
656 "response": {
657 "$ref": "Operation"
658 },
659 "scopes": [
660 "https://www.googleapis.com/auth/appengine.admin",
661 "https://www.googleapis.com/auth/cloud-platform",
662 "https://www.googleapis.com/auth/cloud-platform.read-only"
663 ]
664 },
665 "list": {
666 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
667 "flatPath": "v1alpha/apps/{appsId}/operations",
668 "httpMethod": "GET",
669 "id": "appengine.apps.operations.list",
670 "parameterOrder": [
671 "appsId"
672 ],
673 "parameters": {
674 "appsId": {
675 "description": "Part of `name`. The name of the operation's parent resource.",
676 "location": "path",
677 "required": true,
678 "type": "string"
679 },
680 "filter": {
681 "description": "The standard list filter.",
682 "location": "query",
683 "type": "string"
684 },
685 "pageSize": {
686 "description": "The standard list page size.",
687 "format": "int32",
688 "location": "query",
689 "type": "integer"
690 },
691 "pageToken": {
692 "description": "The standard list page token.",
693 "location": "query",
694 "type": "string"
695 }
696 },
697 "path": "v1alpha/apps/{appsId}/operations",
698 "response": {
699 "$ref": "ListOperationsResponse"
700 },
701 "scopes": [
702 "https://www.googleapis.com/auth/appengine.admin",
703 "https://www.googleapis.com/auth/cloud-platform",
704 "https://www.googleapis.com/auth/cloud-platform.read-only"
705 ]
706 }
707 }
708 }
709 }
710 },
711 "projects": {
712 "resources": {
713 "locations": {
714 "methods": {
715 "get": {
716 "description": "Gets information about a location.",
717 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}",
718 "httpMethod": "GET",
719 "id": "appengine.projects.locations.get",
720 "parameterOrder": [
721 "projectsId",
722 "locationsId"
723 ],
724 "parameters": {
725 "locationsId": {
726 "description": "Part of `name`. See documentation of `projectsId`.",
727 "location": "path",
728 "required": true,
729 "type": "string"
730 },
731 "projectsId": {
732 "description": "Part of `name`. Resource name for the location.",
733 "location": "path",
734 "required": true,
735 "type": "string"
736 }
737 },
738 "path": "v1alpha/projects/{projectsId}/locations/{locationsId}",
739 "response": {
740 "$ref": "Location"
741 },
742 "scopes": [
743 "https://www.googleapis.com/auth/appengine.admin",
744 "https://www.googleapis.com/auth/cloud-platform",
745 "https://www.googleapis.com/auth/cloud-platform.read-only"
746 ]
747 },
748 "list": {
749 "description": "Lists information about the supported locations for this service.",
750 "flatPath": "v1alpha/projects/{projectsId}/locations",
751 "httpMethod": "GET",
752 "id": "appengine.projects.locations.list",
753 "parameterOrder": [
754 "projectsId"
755 ],
756 "parameters": {
757 "filter": {
758 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in AIP-160 (https://google.aip.dev/160).",
759 "location": "query",
760 "type": "string"
761 },
762 "pageSize": {
763 "description": "The maximum number of results to return. If not set, the service selects a default.",
764 "format": "int32",
765 "location": "query",
766 "type": "integer"
767 },
768 "pageToken": {
769 "description": "A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.",
770 "location": "query",
771 "type": "string"
772 },
773 "projectsId": {
774 "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
775 "location": "path",
776 "required": true,
777 "type": "string"
778 }
779 },
780 "path": "v1alpha/projects/{projectsId}/locations",
781 "response": {
782 "$ref": "ListLocationsResponse"
783 },
784 "scopes": [
785 "https://www.googleapis.com/auth/appengine.admin",
786 "https://www.googleapis.com/auth/cloud-platform",
787 "https://www.googleapis.com/auth/cloud-platform.read-only"
788 ]
789 }
790 },
791 "resources": {
792 "applications": {
793 "resources": {
794 "authorizedDomains": {
795 "methods": {
796 "list": {
797 "description": "Lists all domains the user is authorized to administer.",
798 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
799 "httpMethod": "GET",
800 "id": "appengine.projects.locations.applications.authorizedDomains.list",
801 "parameterOrder": [
802 "projectsId",
803 "locationsId",
804 "applicationsId"
805 ],
806 "parameters": {
807 "applicationsId": {
808 "description": "Part of `parent`. See documentation of `projectsId`.",
809 "location": "path",
810 "required": true,
811 "type": "string"
812 },
813 "locationsId": {
814 "description": "Part of `parent`. See documentation of `projectsId`.",
815 "location": "path",
816 "required": true,
817 "type": "string"
818 },
819 "pageSize": {
820 "description": "Maximum results to return per page.",
821 "format": "int32",
822 "location": "query",
823 "type": "integer"
824 },
825 "pageToken": {
826 "description": "Continuation token for fetching the next page of results.",
827 "location": "query",
828 "type": "string"
829 },
830 "projectsId": {
831 "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
832 "location": "path",
833 "required": true,
834 "type": "string"
835 }
836 },
837 "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/applications/{applicationsId}/authorizedDomains",
838 "response": {
839 "$ref": "ListAuthorizedDomainsResponse"
840 },
841 "scopes": [
842 "https://www.googleapis.com/auth/appengine.admin",
843 "https://www.googleapis.com/auth/cloud-platform",
844 "https://www.googleapis.com/auth/cloud-platform.read-only"
845 ]
846 }
847 }
848 }
849 }
850 },
851 "operations": {
852 "methods": {
853 "get": {
854 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
855 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
856 "httpMethod": "GET",
857 "id": "appengine.projects.locations.operations.get",
858 "parameterOrder": [
859 "projectsId",
860 "locationsId",
861 "operationsId"
862 ],
863 "parameters": {
864 "locationsId": {
865 "description": "Part of `name`. See documentation of `projectsId`.",
866 "location": "path",
867 "required": true,
868 "type": "string"
869 },
870 "operationsId": {
871 "description": "Part of `name`. See documentation of `projectsId`.",
872 "location": "path",
873 "required": true,
874 "type": "string"
875 },
876 "projectsId": {
877 "description": "Part of `name`. The name of the operation resource.",
878 "location": "path",
879 "required": true,
880 "type": "string"
881 }
882 },
883 "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
884 "response": {
885 "$ref": "Operation"
886 },
887 "scopes": [
888 "https://www.googleapis.com/auth/appengine.admin",
889 "https://www.googleapis.com/auth/cloud-platform",
890 "https://www.googleapis.com/auth/cloud-platform.read-only"
891 ]
892 },
893 "list": {
894 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.",
895 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
896 "httpMethod": "GET",
897 "id": "appengine.projects.locations.operations.list",
898 "parameterOrder": [
899 "projectsId",
900 "locationsId"
901 ],
902 "parameters": {
903 "filter": {
904 "description": "The standard list filter.",
905 "location": "query",
906 "type": "string"
907 },
908 "locationsId": {
909 "description": "Part of `name`. See documentation of `projectsId`.",
910 "location": "path",
911 "required": true,
912 "type": "string"
913 },
914 "pageSize": {
915 "description": "The standard list page size.",
916 "format": "int32",
917 "location": "query",
918 "type": "integer"
919 },
920 "pageToken": {
921 "description": "The standard list page token.",
922 "location": "query",
923 "type": "string"
924 },
925 "projectsId": {
926 "description": "Part of `name`. The name of the operation's parent resource.",
927 "location": "path",
928 "required": true,
929 "type": "string"
930 }
931 },
932 "path": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations",
933 "response": {
934 "$ref": "ListOperationsResponse"
935 },
936 "scopes": [
937 "https://www.googleapis.com/auth/appengine.admin",
938 "https://www.googleapis.com/auth/cloud-platform",
939 "https://www.googleapis.com/auth/cloud-platform.read-only"
940 ]
941 }
942 }
943 }
944 }
945 }
946 }
947 }
948 },
949 "revision": "20240415",
950 "rootUrl": "https://appengine.googleapis.com/",
951 "schemas": {
952 "AuthorizedCertificate": {
953 "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.",
954 "id": "AuthorizedCertificate",
955 "properties": {
956 "certificateRawData": {
957 "$ref": "CertificateRawData",
958 "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority."
959 },
960 "displayName": {
961 "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.",
962 "type": "string"
963 },
964 "domainMappingsCount": {
965 "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
966 "format": "int32",
967 "type": "integer"
968 },
969 "domainNames": {
970 "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly",
971 "items": {
972 "type": "string"
973 },
974 "type": "array"
975 },
976 "expireTime": {
977 "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly",
978 "format": "google-datetime",
979 "type": "string"
980 },
981 "id": {
982 "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly",
983 "type": "string"
984 },
985 "managedCertificate": {
986 "$ref": "ManagedCertificate",
987 "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly"
988 },
989 "name": {
990 "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly",
991 "type": "string"
992 },
993 "visibleDomainMappings": {
994 "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly",
995 "items": {
996 "type": "string"
997 },
998 "type": "array"
999 }
1000 },
1001 "type": "object"
1002 },
1003 "AuthorizedDomain": {
1004 "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Search Console (https://search.google.com/search-console/welcome).",
1005 "id": "AuthorizedDomain",
1006 "properties": {
1007 "id": {
1008 "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.",
1009 "type": "string"
1010 },
1011 "name": {
1012 "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly",
1013 "type": "string"
1014 }
1015 },
1016 "type": "object"
1017 },
1018 "CertificateRawData": {
1019 "description": "An SSL certificate obtained from a certificate authority.",
1020 "id": "CertificateRawData",
1021 "properties": {
1022 "privateKey": {
1023 "description": "Unencrypted PEM encoded RSA private key. This field is set once on certificate creation and then encrypted. The key size must be 2048 bits or fewer. Must include the header and footer. Example: -----BEGIN RSA PRIVATE KEY----- -----END RSA PRIVATE KEY----- @InputOnly",
1024 "type": "string"
1025 },
1026 "publicCertificate": {
1027 "description": "PEM encoded x.509 public key certificate. This field is set once on certificate creation. Must include the header and footer. Example: -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- ",
1028 "type": "string"
1029 }
1030 },
1031 "type": "object"
1032 },
1033 "ContainerState": {
1034 "description": "ContainerState contains the externally-visible container state that is used to communicate the state and reasoning for that state to the CLH. This data is not persisted by CCFE, but is instead derived from CCFE's internal representation of the container state.",
1035 "id": "ContainerState",
1036 "properties": {
1037 "currentReasons": {
1038 "$ref": "Reasons"
1039 },
1040 "previousReasons": {
1041 "$ref": "Reasons",
1042 "description": "The previous and current reasons for a container state will be sent for a container event. CLHs that need to know the signal that caused the container event to trigger (edges) as opposed to just knowing the state can act upon differences in the previous and current reasons.Reasons will be provided for every system: service management, data governance, abuse, and billing.If this is a CCFE-triggered event used for reconciliation then the current reasons will be set to their *_CONTROL_PLANE_SYNC state. The previous reasons will contain the last known set of non-unknown non-control_plane_sync reasons for the state."
1043 },
1044 "state": {
1045 "description": "The current state of the container. This state is the culmination of all of the opinions from external systems that CCFE knows about of the container.",
1046 "enum": [
1047 "UNKNOWN_STATE",
1048 "ON",
1049 "OFF",
1050 "DELETED"
1051 ],
1052 "enumDescriptions": [
1053 "A container should never be in an unknown state. Receipt of a container with this state is an error.",
1054 "CCFE considers the container to be serving or transitioning into serving.",
1055 "CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
1056 "This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
1057 ],
1058 "type": "string"
1059 }
1060 },
1061 "type": "object"
1062 },
1063 "CreateVersionMetadataV1": {
1064 "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1.CreateVersionRequest.",
1065 "id": "CreateVersionMetadataV1",
1066 "properties": {
1067 "cloudBuildId": {
1068 "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
1069 "type": "string"
1070 }
1071 },
1072 "type": "object"
1073 },
1074 "CreateVersionMetadataV1Alpha": {
1075 "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.",
1076 "id": "CreateVersionMetadataV1Alpha",
1077 "properties": {
1078 "cloudBuildId": {
1079 "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
1080 "type": "string"
1081 }
1082 },
1083 "type": "object"
1084 },
1085 "CreateVersionMetadataV1Beta": {
1086 "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.",
1087 "id": "CreateVersionMetadataV1Beta",
1088 "properties": {
1089 "cloudBuildId": {
1090 "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly",
1091 "type": "string"
1092 }
1093 },
1094 "type": "object"
1095 },
1096 "DomainMapping": {
1097 "description": "A domain serving an App Engine application.",
1098 "id": "DomainMapping",
1099 "properties": {
1100 "id": {
1101 "description": "Relative name of the domain serving the application. Example: example.com.",
1102 "type": "string"
1103 },
1104 "name": {
1105 "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly",
1106 "type": "string"
1107 },
1108 "resourceRecords": {
1109 "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly",
1110 "items": {
1111 "$ref": "ResourceRecord"
1112 },
1113 "type": "array"
1114 },
1115 "sslSettings": {
1116 "$ref": "SslSettings",
1117 "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL."
1118 }
1119 },
1120 "type": "object"
1121 },
1122 "Empty": {
1123 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } ",
1124 "id": "Empty",
1125 "properties": {},
1126 "type": "object"
1127 },
1128 "GoogleAppengineV1betaLocationMetadata": {
1129 "description": "Metadata for the given google.cloud.location.Location.",
1130 "id": "GoogleAppengineV1betaLocationMetadata",
1131 "properties": {
1132 "flexibleEnvironmentAvailable": {
1133 "description": "App Engine flexible environment is available in the given location.@OutputOnly",
1134 "type": "boolean"
1135 },
1136 "searchApiAvailable": {
1137 "description": "Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.",
1138 "readOnly": true,
1139 "type": "boolean"
1140 },
1141 "standardEnvironmentAvailable": {
1142 "description": "App Engine standard environment is available in the given location.@OutputOnly",
1143 "type": "boolean"
1144 }
1145 },
1146 "type": "object"
1147 },
1148 "ListAuthorizedCertificatesResponse": {
1149 "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.",
1150 "id": "ListAuthorizedCertificatesResponse",
1151 "properties": {
1152 "certificates": {
1153 "description": "The SSL certificates the user is authorized to administer.",
1154 "items": {
1155 "$ref": "AuthorizedCertificate"
1156 },
1157 "type": "array"
1158 },
1159 "nextPageToken": {
1160 "description": "Continuation token for fetching the next page of results.",
1161 "type": "string"
1162 }
1163 },
1164 "type": "object"
1165 },
1166 "ListAuthorizedDomainsResponse": {
1167 "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.",
1168 "id": "ListAuthorizedDomainsResponse",
1169 "properties": {
1170 "domains": {
1171 "description": "The authorized domains belonging to the user.",
1172 "items": {
1173 "$ref": "AuthorizedDomain"
1174 },
1175 "type": "array"
1176 },
1177 "nextPageToken": {
1178 "description": "Continuation token for fetching the next page of results.",
1179 "type": "string"
1180 }
1181 },
1182 "type": "object"
1183 },
1184 "ListDomainMappingsResponse": {
1185 "description": "Response message for DomainMappings.ListDomainMappings.",
1186 "id": "ListDomainMappingsResponse",
1187 "properties": {
1188 "domainMappings": {
1189 "description": "The domain mappings for the application.",
1190 "items": {
1191 "$ref": "DomainMapping"
1192 },
1193 "type": "array"
1194 },
1195 "nextPageToken": {
1196 "description": "Continuation token for fetching the next page of results.",
1197 "type": "string"
1198 }
1199 },
1200 "type": "object"
1201 },
1202 "ListLocationsResponse": {
1203 "description": "The response message for Locations.ListLocations.",
1204 "id": "ListLocationsResponse",
1205 "properties": {
1206 "locations": {
1207 "description": "A list of locations that matches the specified filter in the request.",
1208 "items": {
1209 "$ref": "Location"
1210 },
1211 "type": "array"
1212 },
1213 "nextPageToken": {
1214 "description": "The standard List next-page token.",
1215 "type": "string"
1216 }
1217 },
1218 "type": "object"
1219 },
1220 "ListOperationsResponse": {
1221 "description": "The response message for Operations.ListOperations.",
1222 "id": "ListOperationsResponse",
1223 "properties": {
1224 "nextPageToken": {
1225 "description": "The standard List next-page token.",
1226 "type": "string"
1227 },
1228 "operations": {
1229 "description": "A list of operations that matches the specified filter in the request.",
1230 "items": {
1231 "$ref": "Operation"
1232 },
1233 "type": "array"
1234 }
1235 },
1236 "type": "object"
1237 },
1238 "Location": {
1239 "description": "A resource that represents a Google Cloud location.",
1240 "id": "Location",
1241 "properties": {
1242 "displayName": {
1243 "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
1244 "type": "string"
1245 },
1246 "labels": {
1247 "additionalProperties": {
1248 "type": "string"
1249 },
1250 "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"} ",
1251 "type": "object"
1252 },
1253 "locationId": {
1254 "description": "The canonical id for this location. For example: \"us-east1\".",
1255 "type": "string"
1256 },
1257 "metadata": {
1258 "additionalProperties": {
1259 "description": "Properties of the object. Contains field @type with type URL.",
1260 "type": "any"
1261 },
1262 "description": "Service-specific metadata. For example the available capacity at the given location.",
1263 "type": "object"
1264 },
1265 "name": {
1266 "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
1267 "type": "string"
1268 }
1269 },
1270 "type": "object"
1271 },
1272 "LocationMetadata": {
1273 "description": "Metadata for the given google.cloud.location.Location.",
1274 "id": "LocationMetadata",
1275 "properties": {
1276 "flexibleEnvironmentAvailable": {
1277 "description": "App Engine flexible environment is available in the given location.@OutputOnly",
1278 "type": "boolean"
1279 },
1280 "searchApiAvailable": {
1281 "description": "Output only. Search API (https://cloud.google.com/appengine/docs/standard/python/search) is available in the given location.",
1282 "readOnly": true,
1283 "type": "boolean"
1284 },
1285 "standardEnvironmentAvailable": {
1286 "description": "App Engine standard environment is available in the given location.@OutputOnly",
1287 "type": "boolean"
1288 }
1289 },
1290 "type": "object"
1291 },
1292 "ManagedCertificate": {
1293 "description": "A certificate managed by App Engine.",
1294 "id": "ManagedCertificate",
1295 "properties": {
1296 "lastRenewalTime": {
1297 "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly",
1298 "format": "google-datetime",
1299 "type": "string"
1300 },
1301 "status": {
1302 "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly",
1303 "enum": [
1304 "UNSPECIFIED_STATUS",
1305 "OK",
1306 "PENDING",
1307 "FAILED_RETRYING_INTERNAL",
1308 "FAILED_RETRYING_NOT_VISIBLE",
1309 "FAILED_PERMANENTLY_NOT_VISIBLE",
1310 "FAILED_RETRYING_CAA_FORBIDDEN",
1311 "FAILED_RETRYING_CAA_CHECKING"
1312 ],
1313 "enumDescriptions": [
1314 "",
1315 "Certificate was successfully obtained and inserted into the serving system.",
1316 "Certificate is under active attempts to acquire or renew.",
1317 "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.",
1318 "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.",
1319 "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.",
1320 "Most recent renewal failed due to an explicit CAA record that does not include one of the in-use CAs (Google CA and Let's Encrypt). Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.",
1321 "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving."
1322 ],
1323 "type": "string"
1324 }
1325 },
1326 "type": "object"
1327 },
1328 "Operation": {
1329 "description": "This resource represents a long-running operation that is the result of a network API call.",
1330 "id": "Operation",
1331 "properties": {
1332 "done": {
1333 "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
1334 "type": "boolean"
1335 },
1336 "error": {
1337 "$ref": "Status",
1338 "description": "The error result of the operation in case of failure or cancellation."
1339 },
1340 "metadata": {
1341 "additionalProperties": {
1342 "description": "Properties of the object. Contains field @type with type URL.",
1343 "type": "any"
1344 },
1345 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
1346 "type": "object"
1347 },
1348 "name": {
1349 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.",
1350 "type": "string"
1351 },
1352 "response": {
1353 "additionalProperties": {
1354 "description": "Properties of the object. Contains field @type with type URL.",
1355 "type": "any"
1356 },
1357 "description": "The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
1358 "type": "object"
1359 }
1360 },
1361 "type": "object"
1362 },
1363 "OperationMetadataV1": {
1364 "description": "Metadata for the given google.longrunning.Operation.",
1365 "id": "OperationMetadataV1",
1366 "properties": {
1367 "createVersionMetadata": {
1368 "$ref": "CreateVersionMetadataV1"
1369 },
1370 "endTime": {
1371 "description": "Time that this operation completed.@OutputOnly",
1372 "format": "google-datetime",
1373 "type": "string"
1374 },
1375 "ephemeralMessage": {
1376 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
1377 "type": "string"
1378 },
1379 "insertTime": {
1380 "description": "Time that this operation was created.@OutputOnly",
1381 "format": "google-datetime",
1382 "type": "string"
1383 },
1384 "method": {
1385 "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
1386 "type": "string"
1387 },
1388 "target": {
1389 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1390 "type": "string"
1391 },
1392 "user": {
1393 "description": "User who requested this operation.@OutputOnly",
1394 "type": "string"
1395 },
1396 "warning": {
1397 "description": "Durable messages that persist on every operation poll. @OutputOnly",
1398 "items": {
1399 "type": "string"
1400 },
1401 "type": "array"
1402 }
1403 },
1404 "type": "object"
1405 },
1406 "OperationMetadataV1Alpha": {
1407 "description": "Metadata for the given google.longrunning.Operation.",
1408 "id": "OperationMetadataV1Alpha",
1409 "properties": {
1410 "createVersionMetadata": {
1411 "$ref": "CreateVersionMetadataV1Alpha"
1412 },
1413 "endTime": {
1414 "description": "Time that this operation completed.@OutputOnly",
1415 "format": "google-datetime",
1416 "type": "string"
1417 },
1418 "ephemeralMessage": {
1419 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
1420 "type": "string"
1421 },
1422 "insertTime": {
1423 "description": "Time that this operation was created.@OutputOnly",
1424 "format": "google-datetime",
1425 "type": "string"
1426 },
1427 "method": {
1428 "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly",
1429 "type": "string"
1430 },
1431 "target": {
1432 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1433 "type": "string"
1434 },
1435 "user": {
1436 "description": "User who requested this operation.@OutputOnly",
1437 "type": "string"
1438 },
1439 "warning": {
1440 "description": "Durable messages that persist on every operation poll. @OutputOnly",
1441 "items": {
1442 "type": "string"
1443 },
1444 "type": "array"
1445 }
1446 },
1447 "type": "object"
1448 },
1449 "OperationMetadataV1Beta": {
1450 "description": "Metadata for the given google.longrunning.Operation.",
1451 "id": "OperationMetadataV1Beta",
1452 "properties": {
1453 "createVersionMetadata": {
1454 "$ref": "CreateVersionMetadataV1Beta"
1455 },
1456 "endTime": {
1457 "description": "Time that this operation completed.@OutputOnly",
1458 "format": "google-datetime",
1459 "type": "string"
1460 },
1461 "ephemeralMessage": {
1462 "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
1463 "type": "string"
1464 },
1465 "insertTime": {
1466 "description": "Time that this operation was created.@OutputOnly",
1467 "format": "google-datetime",
1468 "type": "string"
1469 },
1470 "method": {
1471 "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
1472 "type": "string"
1473 },
1474 "target": {
1475 "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
1476 "type": "string"
1477 },
1478 "user": {
1479 "description": "User who requested this operation.@OutputOnly",
1480 "type": "string"
1481 },
1482 "warning": {
1483 "description": "Durable messages that persist on every operation poll. @OutputOnly",
1484 "items": {
1485 "type": "string"
1486 },
1487 "type": "array"
1488 }
1489 },
1490 "type": "object"
1491 },
1492 "ProjectEvent": {
1493 "description": "The request sent to CLHs during project events.",
1494 "id": "ProjectEvent",
1495 "properties": {
1496 "eventId": {
1497 "description": "The unique ID for this project event. CLHs can use this value to dedup repeated calls. required",
1498 "type": "string"
1499 },
1500 "phase": {
1501 "description": "Phase indicates when in the container event propagation this event is being communicated. Events are sent before and after the per-resource events are propagated. required",
1502 "enum": [
1503 "CONTAINER_EVENT_PHASE_UNSPECIFIED",
1504 "BEFORE_RESOURCE_HANDLING",
1505 "AFTER_RESOURCE_HANDLING"
1506 ],
1507 "enumDescriptions": [
1508 "",
1509 "",
1510 ""
1511 ],
1512 "type": "string"
1513 },
1514 "projectMetadata": {
1515 "$ref": "ProjectsMetadata",
1516 "description": "The projects metadata for this project. required"
1517 },
1518 "state": {
1519 "$ref": "ContainerState",
1520 "description": "The state of the organization that led to this event."
1521 }
1522 },
1523 "type": "object"
1524 },
1525 "ProjectsMetadata": {
1526 "description": "ProjectsMetadata is the metadata CCFE stores about the all the relevant projects (tenant, consumer, producer).",
1527 "id": "ProjectsMetadata",
1528 "properties": {
1529 "consumerProjectId": {
1530 "description": "The consumer project id.",
1531 "type": "string"
1532 },
1533 "consumerProjectNumber": {
1534 "description": "The consumer project number.",
1535 "format": "int64",
1536 "type": "string"
1537 },
1538 "consumerProjectState": {
1539 "description": "The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel.",
1540 "enum": [
1541 "UNKNOWN_STATE",
1542 "ON",
1543 "OFF",
1544 "DELETED"
1545 ],
1546 "enumDescriptions": [
1547 "A container should never be in an unknown state. Receipt of a container with this state is an error.",
1548 "CCFE considers the container to be serving or transitioning into serving.",
1549 "CCFE considers the container to be in an OFF state. This could occur due to various factors. The state could be triggered by Google-internal audits (ex. abuse suspension, billing closed) or cleanups trigged by compliance systems (ex. data governance hide). User-initiated events such as service management deactivation trigger a container to an OFF state.CLHs might choose to do nothing in this case or to turn off costly resources. CLHs need to consider the customer experience if an ON/OFF/ON sequence of state transitions occurs vs. the cost of deleting resources, keeping metadata about resources, or even keeping resources live for a period of time.CCFE will not send any new customer requests to the CLH when the container is in an OFF state. However, CCFE will allow all previous customer requests relayed to CLH to complete.",
1550 "This state indicates that the container has been (or is being) completely removed. This is often due to a data governance purge request and therefore resources should be deleted when this state is reached."
1551 ],
1552 "type": "string"
1553 },
1554 "p4ServiceAccount": {
1555 "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.",
1556 "type": "string"
1557 },
1558 "producerProjectId": {
1559 "description": "The producer project id.",
1560 "type": "string"
1561 },
1562 "producerProjectNumber": {
1563 "description": "The producer project number.",
1564 "format": "int64",
1565 "type": "string"
1566 },
1567 "tenantProjectId": {
1568 "description": "The tenant project id.",
1569 "type": "string"
1570 },
1571 "tenantProjectNumber": {
1572 "description": "The tenant project number.",
1573 "format": "int64",
1574 "type": "string"
1575 }
1576 },
1577 "type": "object"
1578 },
1579 "Reasons": {
1580 "description": "Containers transition between and within states based on reasons sent from various systems. CCFE will provide the CLH with reasons for the current state per system.The current systems that CCFE supports are: Service Management (Inception) Data Governance (Wipeout) Abuse (Ares) Billing (Internal Cloud Billing API) Service Activation (Service Controller)",
1581 "id": "Reasons",
1582 "properties": {
1583 "abuse": {
1584 "enum": [
1585 "ABUSE_UNKNOWN_REASON",
1586 "ABUSE_CONTROL_PLANE_SYNC",
1587 "SUSPEND",
1588 "REINSTATE"
1589 ],
1590 "enumDescriptions": [
1591 "An unknown reason indicates that the abuse system has not sent a signal for this container.",
1592 "Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
1593 "If a container is deemed abusive we receive a suspend signal. Suspend is a reason to put the container into an INTERNAL_OFF state.",
1594 "Containers that were once considered abusive can later be deemed non-abusive. When this happens we must reinstate the container. Reinstate is a reason to put the container into an ON state."
1595 ],
1596 "type": "string"
1597 },
1598 "billing": {
1599 "enum": [
1600 "BILLING_UNKNOWN_REASON",
1601 "BILLING_CONTROL_PLANE_SYNC",
1602 "PROBATION",
1603 "CLOSE",
1604 "OPEN"
1605 ],
1606 "enumDescriptions": [
1607 "An unknown reason indicates that the billing system has not sent a signal for this container.",
1608 "Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
1609 "Minor infractions cause a probation signal to be sent. Probation is a reason to put the container into a ON state even though it is a negative signal. CCFE will block mutations for this container while it is on billing probation, but the CLH is expected to serve non-mutation requests.",
1610 "When a billing account is closed, it is a stronger signal about non-payment. Close is a reason to put the container into an INTERNAL_OFF state.",
1611 "Consumers can re-open billing accounts and update accounts to pull them out of probation. When this happens, we get a signal that the account is open. Open is a reason to put the container into an ON state."
1612 ],
1613 "type": "string"
1614 },
1615 "dataGovernance": {
1616 "enum": [
1617 "DATA_GOVERNANCE_UNKNOWN_REASON",
1618 "DATA_GOVERNANCE_CONTROL_PLANE_SYNC",
1619 "HIDE",
1620 "UNHIDE",
1621 "PURGE"
1622 ],
1623 "enumDescriptions": [
1624 "An unknown reason indicates that data governance has not sent a signal for this container.",
1625 "Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
1626 "When a container is deleted we retain some data for a period of time to allow the consumer to change their mind. Data governance sends a signal to hide the data when this occurs. Hide is a reason to put the container in an INTERNAL_OFF state.",
1627 "The decision to un-delete a container can be made. When this happens data governance tells us to unhide any hidden data. Unhide is a reason to put the container in an ON state.",
1628 "After a period of time data must be completely removed from our systems. When data governance sends a purge signal we need to remove data. Purge is a reason to put the container in a DELETED state. Purge is the only event that triggers a delete mutation. All other events have update semantics."
1629 ],
1630 "type": "string"
1631 },
1632 "serviceActivation": {
1633 "description": "Consumer Container denotes if the service is active within a project or not. This information could be used to clean up resources in case service in DISABLED_FULL i.e. Service is inactive \u003e 30 days.",
1634 "enum": [
1635 "SERVICE_ACTIVATION_STATUS_UNSPECIFIED",
1636 "SERVICE_ACTIVATION_ENABLED",
1637 "SERVICE_ACTIVATION_DISABLED",
1638 "SERVICE_ACTIVATION_DISABLED_FULL",
1639 "SERVICE_ACTIVATION_UNKNOWN_REASON"
1640 ],
1641 "enumDescriptions": [
1642 "Default Unspecified status",
1643 "Service is active in the project.",
1644 "Service is disabled in the project recently i.e., within last 24 hours.",
1645 "Service has been disabled for configured grace_period (default 30 days).",
1646 "Happens when PSM cannot determine the status of service in a project Could happen due to variety of reasons like PERMISSION_DENIED or Project got deleted etc."
1647 ],
1648 "type": "string"
1649 },
1650 "serviceManagement": {
1651 "enum": [
1652 "SERVICE_MANAGEMENT_UNKNOWN_REASON",
1653 "SERVICE_MANAGEMENT_CONTROL_PLANE_SYNC",
1654 "ACTIVATION",
1655 "PREPARE_DEACTIVATION",
1656 "ABORT_DEACTIVATION",
1657 "COMMIT_DEACTIVATION"
1658 ],
1659 "enumDeprecated": [
1660 false,
1661 false,
1662 true,
1663 true,
1664 true,
1665 true
1666 ],
1667 "enumDescriptions": [
1668 "An unknown reason indicates that we have not received a signal from service management about this container. Since containers are created by request of service management, this reason should never be set.",
1669 "Due to various reasons CCFE might proactively restate a container state to a CLH to ensure that the CLH and CCFE are both aware of the container state. This reason can be tied to any of the states.",
1670 "When a customer activates an API CCFE notifies the CLH and sets the container to the ON state.",
1671 "When a customer deactivates and API service management starts a two-step process to perform the deactivation. The first step is to prepare. Prepare is a reason to put the container in a EXTERNAL_OFF state.",
1672 "If the deactivation is cancelled, service managed needs to abort the deactivation. Abort is a reason to put the container in an ON state.",
1673 "If the deactivation is followed through with, service management needs to finish deactivation. Commit is a reason to put the container in a DELETED state."
1674 ],
1675 "type": "string"
1676 }
1677 },
1678 "type": "object"
1679 },
1680 "ResourceRecord": {
1681 "description": "A DNS resource record.",
1682 "id": "ResourceRecord",
1683 "properties": {
1684 "name": {
1685 "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.",
1686 "type": "string"
1687 },
1688 "rrdata": {
1689 "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).",
1690 "type": "string"
1691 },
1692 "type": {
1693 "description": "Resource record type. Example: AAAA.",
1694 "enum": [
1695 "A",
1696 "AAAA",
1697 "CNAME"
1698 ],
1699 "enumDescriptions": [
1700 "An A resource record. Data is an IPv4 address.",
1701 "An AAAA resource record. Data is an IPv6 address.",
1702 "A CNAME resource record. Data is a domain name to be aliased."
1703 ],
1704 "type": "string"
1705 }
1706 },
1707 "type": "object"
1708 },
1709 "SslSettings": {
1710 "description": "SSL configuration for a DomainMapping resource.",
1711 "id": "SslSettings",
1712 "properties": {
1713 "certificateId": {
1714 "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.",
1715 "type": "string"
1716 },
1717 "isManagedCertificate": {
1718 "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly",
1719 "type": "boolean"
1720 }
1721 },
1722 "type": "object"
1723 },
1724 "Status": {
1725 "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).",
1726 "id": "Status",
1727 "properties": {
1728 "code": {
1729 "description": "The status code, which should be an enum value of google.rpc.Code.",
1730 "format": "int32",
1731 "type": "integer"
1732 },
1733 "details": {
1734 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
1735 "items": {
1736 "additionalProperties": {
1737 "description": "Properties of the object. Contains field @type with type URL.",
1738 "type": "any"
1739 },
1740 "type": "object"
1741 },
1742 "type": "array"
1743 },
1744 "message": {
1745 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
1746 "type": "string"
1747 }
1748 },
1749 "type": "object"
1750 }
1751 },
1752 "servicePath": "",
1753 "title": "App Engine Admin API",
1754 "version": "v1alpha"
1755}View as plain text