1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="appengine_v1beta.html">App Engine Admin API</a> . <a href="appengine_v1beta.apps.html">apps</a> . <a href="appengine_v1beta.apps.services.html">services</a> . <a href="appengine_v1beta.apps.services.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="appengine_v1beta.apps.services.versions.instances.html">instances()</a></code>
</p>
<p class="firstline">Returns the instances Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(appsId, servicesId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deploys code and resource files to a new version.</p>
<p class="toc_element">
<code><a href="#delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing Version resource.</p>
<p class="toc_element">
<code><a href="#get">get(appsId, servicesId, versionsId, includeExtraData=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.</p>
<p class="toc_element">
<code><a href="#list">list(appsId, servicesId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the versions of a service.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(appsId, servicesId, body=None, x__xgafv=None)</code>
<pre>Deploys code and resource files to a new version.
Args:
appsId: string, Part of `parent`. Required. Name of the parent resource to create this version under. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
body: object, The request body.
The object takes the form of:
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set.
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"url": "A String", # URL to serve the endpoint at.
},
"appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services.
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.
"coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
"aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
"targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
},
"customMetrics": [ # Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.
{ # Allows autoscaling based on Stackdriver metrics.
"filter": "A String", # Allows filtering on the metric's fields.
"metricName": "A String", # The name of the metric.
"singleInstanceAssignment": 3.14, # May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.
"targetType": "A String", # The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
"targetUtilization": 3.14, # The target value for the metric.
},
],
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
},
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
"standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
"maxInstances": 42, # Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.
"minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
"targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
"targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
},
},
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
"betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
"buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
"createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
"cloudBuildId": "A String", # The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9"
},
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
"appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
"cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
},
"container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
"image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
"sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
"rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
},
"entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
"shell": "A String", # The format should be a shell command that can be fed to bash -c.
},
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
"mimeType": "A String", # MIME type of file. Defaults to text/html.
"staticFile": "A String", # Static file content to be served for this error.
},
],
"flexibleRuntimeSettings": { # Runtime settings for the App Engine flexible environment. # Settings for App Engine flexible runtimes.
"operatingSystem": "A String", # The operating system of the application runtime.
"runtimeVersion": "A String", # The runtime version of an App Engine flexible application.
},
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
"redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
"scriptPath": "A String", # Path to the script from the application root directory.
},
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
"path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
},
"urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
},
],
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.
"checkInterval": "A String", # Interval between health checks.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
"healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
"host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"timeout": "A String", # Time before the health check is considered failed.
"unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
},
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
"instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"name": "A String", # Name of the library. Example: "django".
"version": "A String", # Version of the library to select, or "latest".
},
],
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
"host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
"initialDelay": "A String", # The initial delay before starting to execute the checks.
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
"timeout": "A String", # Time before the check is considered failed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
"name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
],
"instanceIpMode": "A String", # The IP mode for instances. Only applicable in the App Engine flexible environment.
"instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
"name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
},
"nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.
"appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
"timeout": "A String", # Time before the check is considered failed.
},
"resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
"cpu": 3.14, # Number of CPU cores needed.
"diskGb": 3.14, # Disk size (GB) needed.
"kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk
"memoryGb": 3.14, # Memory (GB) needed.
"volumes": [ # User specified volumes.
{ # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
"name": "A String", # Unique name for the volume.
"sizeGb": 3.14, # Volume size in gigabytes.
"volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
},
],
},
"runtime": "A String", # Desired runtime. Example: python27.
"runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
"runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
"runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}.
"response": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(appsId, servicesId, versionsId, x__xgafv=None)</code>
<pre>Deletes an existing Version resource.
Args:
appsId: string, Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}.
"response": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(appsId, servicesId, versionsId, includeExtraData=None, view=None, x__xgafv=None)</code>
<pre>Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.
Args:
appsId: string, Part of `name`. Required. Name of the resource requested. Example: apps/myapp/services/default/versions/v1. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
includeExtraData: string, Optional. Options to include extra data
Allowed values
INCLUDE_EXTRA_DATA_UNSPECIFIED - Unspecified: No extra data will be returned
INCLUDE_EXTRA_DATA_NONE - Do not return any extra data
INCLUDE_GOOGLE_GENERATED_METADATA - Return GGCM associated with the resources
view: string, Controls the set of fields returned in the Get response.
Allowed values
BASIC - Basic version information including scaling and inbound services, but not detailed deployment information.
FULL - The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set.
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"url": "A String", # URL to serve the endpoint at.
},
"appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services.
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.
"coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
"aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
"targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
},
"customMetrics": [ # Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.
{ # Allows autoscaling based on Stackdriver metrics.
"filter": "A String", # Allows filtering on the metric's fields.
"metricName": "A String", # The name of the metric.
"singleInstanceAssignment": 3.14, # May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.
"targetType": "A String", # The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
"targetUtilization": 3.14, # The target value for the metric.
},
],
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
},
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
"standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
"maxInstances": 42, # Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.
"minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
"targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
"targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
},
},
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
"betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
"buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
"createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
"cloudBuildId": "A String", # The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9"
},
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
"appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
"cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
},
"container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
"image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
"sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
"rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
},
"entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
"shell": "A String", # The format should be a shell command that can be fed to bash -c.
},
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
"mimeType": "A String", # MIME type of file. Defaults to text/html.
"staticFile": "A String", # Static file content to be served for this error.
},
],
"flexibleRuntimeSettings": { # Runtime settings for the App Engine flexible environment. # Settings for App Engine flexible runtimes.
"operatingSystem": "A String", # The operating system of the application runtime.
"runtimeVersion": "A String", # The runtime version of an App Engine flexible application.
},
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
"redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
"scriptPath": "A String", # Path to the script from the application root directory.
},
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
"path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
},
"urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
},
],
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.
"checkInterval": "A String", # Interval between health checks.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
"healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
"host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"timeout": "A String", # Time before the health check is considered failed.
"unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
},
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
"instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"name": "A String", # Name of the library. Example: "django".
"version": "A String", # Version of the library to select, or "latest".
},
],
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
"host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
"initialDelay": "A String", # The initial delay before starting to execute the checks.
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
"timeout": "A String", # Time before the check is considered failed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
"name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
],
"instanceIpMode": "A String", # The IP mode for instances. Only applicable in the App Engine flexible environment.
"instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
"name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
},
"nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.
"appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
"timeout": "A String", # Time before the check is considered failed.
},
"resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
"cpu": 3.14, # Number of CPU cores needed.
"diskGb": 3.14, # Disk size (GB) needed.
"kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk
"memoryGb": 3.14, # Memory (GB) needed.
"volumes": [ # User specified volumes.
{ # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
"name": "A String", # Unique name for the volume.
"sizeGb": 3.14, # Volume size in gigabytes.
"volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
},
],
},
"runtime": "A String", # Desired runtime. Example: python27.
"runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
"runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
"runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(appsId, servicesId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists the versions of a service.
Args:
appsId: string, Part of `parent`. Required. Name of the parent Service resource. Example: apps/myapp/services/default. (required)
servicesId: string, Part of `parent`. See documentation of `appsId`. (required)
pageSize: integer, Maximum results to return per page.
pageToken: string, Continuation token for fetching the next page of results.
view: string, Controls the set of fields returned in the List response.
Allowed values
BASIC - Basic version information including scaling and inbound services, but not detailed deployment information.
FULL - The information from BASIC, plus detailed information about the deployment. This format is required when creating resources, but is not returned in Get or List by default.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for Versions.ListVersions.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"versions": [ # The versions belonging to the requested service.
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set.
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"url": "A String", # URL to serve the endpoint at.
},
"appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services.
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.
"coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
"aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
"targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
},
"customMetrics": [ # Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.
{ # Allows autoscaling based on Stackdriver metrics.
"filter": "A String", # Allows filtering on the metric's fields.
"metricName": "A String", # The name of the metric.
"singleInstanceAssignment": 3.14, # May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.
"targetType": "A String", # The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
"targetUtilization": 3.14, # The target value for the metric.
},
],
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
},
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
"standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
"maxInstances": 42, # Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.
"minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
"targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
"targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
},
},
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
"betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
"buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
"createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
"cloudBuildId": "A String", # The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9"
},
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
"appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
"cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
},
"container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
"image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
"sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
"rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
},
"entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
"shell": "A String", # The format should be a shell command that can be fed to bash -c.
},
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
"mimeType": "A String", # MIME type of file. Defaults to text/html.
"staticFile": "A String", # Static file content to be served for this error.
},
],
"flexibleRuntimeSettings": { # Runtime settings for the App Engine flexible environment. # Settings for App Engine flexible runtimes.
"operatingSystem": "A String", # The operating system of the application runtime.
"runtimeVersion": "A String", # The runtime version of an App Engine flexible application.
},
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
"redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
"scriptPath": "A String", # Path to the script from the application root directory.
},
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
"path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
},
"urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
},
],
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.
"checkInterval": "A String", # Interval between health checks.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
"healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
"host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"timeout": "A String", # Time before the health check is considered failed.
"unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
},
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
"instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"name": "A String", # Name of the library. Example: "django".
"version": "A String", # Version of the library to select, or "latest".
},
],
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
"host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
"initialDelay": "A String", # The initial delay before starting to execute the checks.
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
"timeout": "A String", # Time before the check is considered failed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
"name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
],
"instanceIpMode": "A String", # The IP mode for instances. Only applicable in the App Engine flexible environment.
"instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
"name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
},
"nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.
"appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
"timeout": "A String", # Time before the check is considered failed.
},
"resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
"cpu": 3.14, # Number of CPU cores needed.
"diskGb": 3.14, # Disk size (GB) needed.
"kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk
"memoryGb": 3.14, # Memory (GB) needed.
"volumes": [ # User specified volumes.
{ # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
"name": "A String", # Unique name for the volume.
"sizeGb": 3.14, # Volume size in gigabytes.
"volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
},
],
},
"runtime": "A String", # Desired runtime. Example: python27.
"runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
"runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
"runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(appsId, servicesId, versionsId, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:Standard environment instance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class)automatic scaling in the standard environment: automatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automaticScaling.standard_scheduler_settings.max_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.min_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_cpu_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings) automaticScaling.standard_scheduler_settings.target_throughput_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StandardSchedulerSettings)basic scaling or manual scaling in the standard environment: serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status) manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)Flexible environment serving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status)automatic scaling in the flexible environment: automatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling) automatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling)manual scaling in the flexible environment: manual_scaling.instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#manualscaling)
Args:
appsId: string, Part of `name`. Required. Name of the resource to update. Example: apps/myapp/services/default/versions/1. (required)
servicesId: string, Part of `name`. See documentation of `appsId`. (required)
versionsId: string, Part of `name`. See documentation of `appsId`. (required)
body: object, The request body.
The object takes the form of:
{ # A Version resource is a specific set of source code and configuration files that are deployed into a service.
"apiConfig": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. # Serving configuration for Google Cloud Endpoints (https://cloud.google.com/endpoints).Only returned in GET requests if view=FULL is set.
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Defaults to optional.
"script": "A String", # Path to the script from the application root directory.
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"url": "A String", # URL to serve the endpoint at.
},
"appEngineApis": True or False, # Allows App Engine second generation runtimes to access the legacy bundled services.
"automaticScaling": { # Automatic scaling is based on request rate, response latencies, and other application metrics. # Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.
"coolDownPeriod": "A String", # The time period that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Only applicable in the App Engine flexible environment.
"cpuUtilization": { # Target scaling by CPU usage. # Target scaling by CPU usage.
"aggregationWindowLength": "A String", # Period of time over which CPU utilization is calculated.
"targetUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
},
"customMetrics": [ # Target scaling by user-provided metrics. Only applicable in the App Engine flexible environment.
{ # Allows autoscaling based on Stackdriver metrics.
"filter": "A String", # Allows filtering on the metric's fields.
"metricName": "A String", # The name of the metric.
"singleInstanceAssignment": 3.14, # May be used instead of target_utilization when an instance can handle a specific amount of work/resources and the metric value is equal to the current amount of work remaining. The autoscaler will try to keep the number of instances equal to the metric value divided by single_instance_assignment.
"targetType": "A String", # The type of the metric. Must be a string representing a Stackdriver metric type e.g. GAGUE, DELTA_PER_SECOND, etc.
"targetUtilization": 3.14, # The target value for the metric.
},
],
"diskUtilization": { # Target scaling by disk usage. Only applicable in the App Engine flexible environment. # Target scaling by disk usage.
"targetReadBytesPerSecond": 42, # Target bytes read per second.
"targetReadOpsPerSecond": 42, # Target ops read per seconds.
"targetWriteBytesPerSecond": 42, # Target bytes written per second.
"targetWriteOpsPerSecond": 42, # Target ops written per second.
},
"maxConcurrentRequests": 42, # Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
"maxIdleInstances": 42, # Maximum number of idle instances that should be maintained for this version.
"maxPendingLatency": "A String", # Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
"maxTotalInstances": 42, # Maximum number of instances that should be started to handle requests for this version.
"minIdleInstances": 42, # Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
"minPendingLatency": "A String", # Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
"minTotalInstances": 42, # Minimum number of running instances that should be maintained for this version.
"networkUtilization": { # Target scaling by network usage. Only applicable in the App Engine flexible environment. # Target scaling by network usage.
"targetReceivedBytesPerSecond": 42, # Target bytes received per second.
"targetReceivedPacketsPerSecond": 42, # Target packets received per second.
"targetSentBytesPerSecond": 42, # Target bytes sent per second.
"targetSentPacketsPerSecond": 42, # Target packets sent per second.
},
"requestUtilization": { # Target scaling by request utilization. Only applicable in the App Engine flexible environment. # Target scaling by request utilization.
"targetConcurrentRequests": 42, # Target number of concurrent requests.
"targetRequestCountPerSecond": 42, # Target requests per second.
},
"standardSchedulerSettings": { # Scheduler settings for standard environment. # Scheduler settings for standard environment.
"maxInstances": 42, # Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.
"minInstances": 42, # Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
"targetCpuUtilization": 3.14, # Target CPU utilization ratio to maintain when scaling.
"targetThroughputUtilization": 3.14, # Target throughput utilization ratio to maintain when scaling
},
},
"basicScaling": { # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. # A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.
"idleTimeout": "A String", # Duration of time after the last request that an instance must wait before the instance is shut down.
"maxInstances": 42, # Maximum number of instances to create for this version.
},
"betaSettings": { # Metadata settings that are supplied to this version to enable beta runtime features.
"a_key": "A String",
},
"buildEnvVariables": { # Environment variables available to the build environment.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
"createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
"cloudBuildId": "A String", # The Google Cloud Build id. Example: "f966068f-08b2-42c8-bdfe-74137dff2bf9"
},
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
"appYamlPath": "A String", # Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See https://cloud.google.com/appengine/docs/standard/python/config/appref for more details.
"cloudBuildTimeout": "A String", # The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
},
"container": { # Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment. # The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
"image": "A String", # URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: "gcr.io/my-project/image:tag" or "gcr.io/my-project/image@digest"
},
"files": { # Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.
"a_key": { # Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.
"mimeType": "A String", # The MIME type of the file.Defaults to the value from Google Cloud Storage.
"sha1Sum": "A String", # The SHA1 hash of the file, in hex.
"sourceUrl": "A String", # URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"zip": { # The zip file information for a zip deployment. # The zip file for this deployment, if this is a zip deployment.
"filesCount": 42, # An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
"diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
"name": "A String", # Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
"rolloutStrategy": "A String", # Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.
},
"entrypoint": { # The entrypoint for the application. # The entrypoint for the application.
"shell": "A String", # The format should be a shell command that can be fed to bash -c.
},
"env": "A String", # App Engine execution environment for this version.Defaults to standard.
"envVariables": { # Environment variables available to the application.Only returned in GET requests if view=FULL is set.
"a_key": "A String",
},
"errorHandlers": [ # Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.
{ # Custom static error page to be served when an error occurs.
"errorCode": "A String", # Error condition this handler applies to.
"mimeType": "A String", # MIME type of file. Defaults to text/html.
"staticFile": "A String", # Static file content to be served for this error.
},
],
"flexibleRuntimeSettings": { # Runtime settings for the App Engine flexible environment. # Settings for App Engine flexible runtimes.
"operatingSystem": "A String", # The operating system of the application runtime.
"runtimeVersion": "A String", # The runtime version of an App Engine flexible application.
},
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetVersionRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"handlers": [ # An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.
{ # URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.
"apiEndpoint": { # Uses Google Cloud Endpoints to handle requests. # Uses API Endpoints to handle requests.
"scriptPath": "A String", # Path to the script from the application root directory.
},
"authFailAction": "A String", # Action to take when users access resources that require authentication. Defaults to redirect.
"login": "A String", # Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.
"redirectHttpResponseCode": "A String", # 30x code to use when performing redirects for the secure field. Defaults to 302.
"script": { # Executes a script to handle the request that matches the URL pattern. # Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example "script": "auto".
"scriptPath": "A String", # Path to the script from the application root directory.
},
"securityLevel": "A String", # Security (HTTPS) enforcement for this URL.
"staticFiles": { # Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. # Returns the contents of a file, such as an image, as the response.
"applicationReadable": True or False, # Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.
"expiration": "A String", # Time a static file served by this handler should be cached by web proxies and browsers.
"httpHeaders": { # HTTP headers to use for all responses from these URLs.
"a_key": "A String",
},
"mimeType": "A String", # MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.
"path": "A String", # Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.
"requireMatchingFile": True or False, # Whether this handler should match the request if the file referenced by the handler does not exist.
"uploadPathRegex": "A String", # Regular expression that matches the file paths for all files that should be referenced by this handler.
},
"urlRegex": "A String", # URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.
},
],
"healthCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. # Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.
"checkInterval": "A String", # Interval between health checks.
"disableHealthCheck": True or False, # Whether to explicitly disable health checks for this instance.
"healthyThreshold": 42, # Number of consecutive successful health checks required before receiving traffic.
"host": "A String", # Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
"restartThreshold": 42, # Number of consecutive failed health checks required before an instance is restarted.
"timeout": "A String", # Time before the health check is considered failed.
"unhealthyThreshold": 42, # Number of consecutive failed health checks required before removing traffic.
},
"id": "A String", # Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".
"inboundServices": [ # Before an application can receive email or XMPP messages, the application must be configured to enable the service.
"A String",
],
"instanceClass": "A String", # Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.
"libraries": [ # Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.
{ # Third-party Python runtime library that is required by the application.
"name": "A String", # Name of the library. Example: "django".
"version": "A String", # Version of the library to select, or "latest".
},
],
"livenessCheck": { # Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. # Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before considering the VM unhealthy.
"host": "A String", # Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
"initialDelay": "A String", # The initial delay before starting to execute the checks.
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before considering the VM healthy.
"timeout": "A String", # Time before the check is considered failed.
},
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
"name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
],
"instanceIpMode": "A String", # The IP mode for instances. Only applicable in the App Engine flexible environment.
"instanceTag": "A String", # Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
"name": "A String", # Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
"sessionAffinity": True or False, # Enable session affinity. Only applicable in the App Engine flexible environment.
"subnetworkName": "A String", # Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.
},
"nobuildFilesRegex": "A String", # Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.
"readinessCheck": { # Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. # Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.
"appStartTimeout": "A String", # A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
"checkInterval": "A String", # Interval between health checks.
"failureThreshold": 42, # Number of consecutive failed checks required before removing traffic.
"host": "A String", # Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
"path": "A String", # The request path.
"successThreshold": 42, # Number of consecutive successful checks required before receiving traffic.
"timeout": "A String", # Time before the check is considered failed.
},
"resources": { # Machine resources for a version. # Machine resources for this version. Only applicable in the App Engine flexible environment.
"cpu": 3.14, # Number of CPU cores needed.
"diskGb": 3.14, # Disk size (GB) needed.
"kmsKeyReference": "A String", # The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk
"memoryGb": 3.14, # Memory (GB) needed.
"volumes": [ # User specified volumes.
{ # Volumes mounted within the app container. Only applicable in the App Engine flexible environment.
"name": "A String", # Unique name for the volume.
"sizeGb": 3.14, # Volume size in gigabytes.
"volumeType": "A String", # Underlying volume type, e.g. 'tmpfs'.
},
],
},
"runtime": "A String", # Desired runtime. Example: python27.
"runtimeApiVersion": "A String", # The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref
"runtimeChannel": "A String", # The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.
"runtimeMainExecutablePath": "A String", # The path or name of the app's main executable.
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
"versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
"name": "A String", # Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.
},
"zones": [ # The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.
"A String",
],
}
updateMask: string, Standard field mask for the set of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}.
"response": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
