/
v1beta5.ts
3384 lines (3226 loc) · 120 KB
/
v1beta5.ts
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
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {GoogleApis} from '../..';
import {BodyResponseCallback, GlobalOptions, MethodOptions} from '../../lib/api';
import {createAPIRequest} from '../../lib/apirequest';
// TODO: We will eventually get the `any` in here cleared out, but in the
// interim we want to turn on no-implicit-any.
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace appengine_v1beta5 {
export interface Options extends GlobalOptions {
version: 'v1beta5';
}
/**
* App Engine Admin API
*
* The App Engine Admin API enables developers to provision and manage their
* App Engine applications.
*
* @example
* const google = require('googleapis');
* const appengine = google.appengine('v1beta5');
*
* @namespace appengine
* @type {Function}
* @version v1beta5
* @variation v1beta5
* @param {object=} options Options for Appengine
*/
export class Appengine {
_options: GlobalOptions;
google: GoogleApis;
root = this;
apps: Resource$Apps;
constructor(options: GlobalOptions, google: GoogleApis) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.apps = new Resource$Apps(this);
}
getRoot() {
return this.root;
}
}
/**
* Google Cloud Endpoints
* (https://cloud.google.com/appengine/docs/python/endpoints/) configuration
* for API handlers.
*/
export interface Schema$ApiConfigHandler {
/**
* Action to take when users access resources that require authentication.
* Defaults to redirect.
*/
authFailAction?: string;
/**
* Level of login required to access this resource. Defaults to optional.
*/
login?: string;
/**
* Path to the script from the application root directory.
*/
script?: string;
/**
* Security (HTTPS) enforcement for this URL.
*/
securityLevel?: string;
/**
* URL to serve the endpoint at.
*/
url?: string;
}
/**
* Uses Google Cloud Endpoints to handle requests.
*/
export interface Schema$ApiEndpointHandler {
/**
* Path to the script from the application root directory.
*/
scriptPath?: string;
}
/**
* An Application resource contains the top-level configuration of an App
* Engine application.
*/
export interface Schema$Application {
/**
* Google Apps authentication domain that controls which users can access
* this application.Defaults to open access for any Google Account.
*/
authDomain?: string;
/**
* A Google Cloud Storage bucket that can be used for storing files
* associated with this application. This bucket is associated with the
* application and can be used by the gcloud deployment commands.@OutputOnly
*/
codeBucket?: string;
/**
* A Google Cloud Storage bucket that can be used by the application to
* store content.@OutputOnly
*/
defaultBucket?: string;
/**
* Cookie expiration policy for this application.
*/
defaultCookieExpiration?: string;
/**
* Hostname used to reach the application, as resolved by App
* Engine.@OutputOnly
*/
defaultHostname?: string;
/**
* HTTP path dispatch rules for requests to the application that do not
* explicitly target a service or version. Rules are
* order-dependent.@OutputOnly
*/
dispatchRules?: Schema$UrlDispatchRule[];
iap?: Schema$IdentityAwareProxy;
/**
* Identifier of the Application resource. This identifier is equivalent to
* the project ID of the Google Cloud Platform project where you want to
* deploy your application. Example: myapp.
*/
id?: string;
/**
* Location from which this application will be run. Application instances
* will run out of data centers in the chosen location, which is also where
* all of the application's end user content is stored.Defaults to
* us-central.Options are:us-central - Central USeurope-west - Western
* Europeus-east1 - Eastern US
*/
location?: string;
/**
* Full path to the Application resource in the API. Example:
* apps/myapp.@OutputOnly
*/
name?: string;
}
/**
* Automatic scaling is based on request rate, response latencies, and other
* application metrics.
*/
export interface Schema$AutomaticScaling {
/**
* Amount of time that the Autoscaler
* (https://cloud.google.com/compute/docs/autoscaler/) should wait between
* changes to the number of virtual machines. Only applicable for VM
* runtimes.
*/
coolDownPeriod?: string;
/**
* Target scaling by CPU usage.
*/
cpuUtilization?: Schema$CpuUtilization;
/**
* Target scaling by disk usage.
*/
diskUtilization?: Schema$DiskUtilization;
/**
* Number of concurrent requests an automatic scaling instance can accept
* before the scheduler spawns a new instance.Defaults to a runtime-specific
* value.
*/
maxConcurrentRequests?: number;
/**
* Maximum number of idle instances that should be maintained for this
* version.
*/
maxIdleInstances?: number;
/**
* Maximum amount of time that a request should wait in the pending queue
* before starting a new instance to handle it.
*/
maxPendingLatency?: string;
/**
* Maximum number of instances that should be started to handle requests.
*/
maxTotalInstances?: number;
/**
* Minimum number of idle instances that should be maintained for this
* version. Only applicable for the default version of a module.
*/
minIdleInstances?: number;
/**
* Minimum amount of time a request should wait in the pending queue before
* starting a new instance to handle it.
*/
minPendingLatency?: string;
/**
* Minimum number of instances that should be maintained for this version.
*/
minTotalInstances?: number;
/**
* Target scaling by network usage.
*/
networkUtilization?: Schema$NetworkUtilization;
/**
* Target scaling by request utilization.
*/
requestUtilization?: Schema$RequestUtilization;
}
/**
* 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.
*/
export interface Schema$BasicScaling {
/**
* Duration of time after the last request that an instance must wait before
* the instance is shut down.
*/
idleTimeout?: string;
/**
* Maximum number of instances to create for this version.
*/
maxInstances?: number;
}
/**
* 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.
*/
export interface Schema$ContainerInfo {
/**
* 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"
*/
image?: string;
}
/**
* Target scaling by CPU usage.
*/
export interface Schema$CpuUtilization {
/**
* Period of time over which CPU utilization is calculated.
*/
aggregationWindowLength?: string;
/**
* Target CPU utilization ratio to maintain when scaling. Must be between 0
* and 1.
*/
targetUtilization?: number;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1 {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1alpha.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Alpha {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Metadata for the given google.longrunning.Operation during a
* google.appengine.v1beta.CreateVersionRequest.
*/
export interface Schema$CreateVersionMetadataV1Beta {
/**
* The Cloud Build ID if one was created as part of the version create.
* @OutputOnly
*/
cloudBuildId?: string;
}
/**
* Request message for Instances.DebugInstance.
*/
export interface Schema$DebugInstanceRequest {
/**
* Public SSH key to add to the instance. Examples: [USERNAME]:ssh-rsa
* [KEY_VALUE] [USERNAME] [USERNAME]:ssh-rsa [KEY_VALUE] google-ssh
* {"userName":"[USERNAME]","expireOn":"[EXPIRE_TIME]"}For
* more information, see Adding and Removing SSH Keys
* (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).
*/
sshKey?: string;
}
/**
* Code and application artifacts used to deploy a version to App Engine.
*/
export interface Schema$Deployment {
/**
* The Docker image for the container that runs the version. Only applicable
* for instances running in the App Engine flexible environment.
*/
container?: Schema$ContainerInfo;
/**
* 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.
*/
files?: any;
/**
* Origin of the source code for this deployment. There can be more than one
* source reference per version if source code is distributed among multiple
* repositories.
*/
sourceReferences?: Schema$SourceReference[];
}
/**
* Target scaling by disk usage. Only applicable for VM runtimes.
*/
export interface Schema$DiskUtilization {
/**
* Target bytes read per second.
*/
targetReadBytesPerSec?: number;
/**
* Target ops read per second.
*/
targetReadOpsPerSec?: number;
/**
* Target bytes written per second.
*/
targetWriteBytesPerSec?: number;
/**
* Target ops written per second.
*/
targetWriteOpsPerSec?: number;
}
/**
* 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).
*/
export interface Schema$EndpointsApiService {
/**
* Endpoints service configuration id as specified by the Service Management
* API. For example "2016-09-19r1"By default, the Endpoints
* service configuration id is fixed and config_id must be specified. To
* keep the Endpoints service configuration id updated with each rollout,
* specify RolloutStrategy.MANAGED and omit config_id.
*/
configId?: string;
/**
* Endpoints service name which is the name of the "service"
* resource in the Service Management API. For example
* "myapi.endpoints.myproject.cloud.goog"
*/
name?: string;
/**
* Endpoints rollout strategy. If FIXED, config_id must be specified. If
* MANAGED, config_id must be omitted.
*/
rolloutStrategy?: string;
}
/**
* Custom static error page to be served when an error occurs.
*/
export interface Schema$ErrorHandler {
/**
* Error condition this handler applies to.
*/
errorCode?: string;
/**
* MIME type of file. Defaults to text/html.
*/
mimeType?: string;
/**
* Static file content to be served for this error.
*/
staticFile?: string;
}
/**
* Single source file that is part of the version to be deployed. Each source
* file that is deployed must be specified separately.
*/
export interface Schema$FileInfo {
/**
* The MIME type of the file.Defaults to the value from Google Cloud
* Storage.
*/
mimeType?: string;
/**
* The SHA1 hash of the file, in hex.
*/
sha1Sum?: 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/<bucket>/<object>'.
*/
sourceUrl?: string;
}
/**
* Health checking configuration for VM instances. Unhealthy instances are
* killed and replaced with new instances. Only applicable for instances in
* App Engine flexible environment.
*/
export interface Schema$HealthCheck {
/**
* Interval between health checks.
*/
checkInterval?: string;
/**
* Whether to explicitly disable health checks for this instance.
*/
disableHealthCheck?: boolean;
/**
* Number of consecutive successful health checks required before receiving
* traffic.
*/
healthyThreshold?: number;
/**
* Host header to send when performing an HTTP health check. Example:
* "myapp.appspot.com"
*/
host?: string;
/**
* Number of consecutive failed health checks required before an instance is
* restarted.
*/
restartThreshold?: number;
/**
* Time before the health check is considered failed.
*/
timeout?: string;
/**
* Number of consecutive failed health checks required before removing
* traffic.
*/
unhealthyThreshold?: number;
}
/**
* Identity-Aware Proxy
*/
export interface Schema$IdentityAwareProxy {
/**
* Whether the serving infrastructure will authenticate and authorize all
* incoming requests.If true, the oauth2_client_id and oauth2_client_secret
* fields must be non-empty.
*/
enabled?: boolean;
/**
* OAuth2 client ID to use for the authentication flow.
*/
oauth2ClientId?: string;
/**
* For security reasons, this value cannot be retrieved via the API.
* Instead, the SHA-256 hash of the value is returned in the
* oauth2_client_secret_sha256 field.@InputOnly
*/
oauth2ClientSecret?: string;
/**
* Hex-encoded SHA-256 hash of the client secret.@OutputOnly
*/
oauth2ClientSecretSha256?: string;
}
/**
* An Instance resource is the computing unit that App Engine uses to
* automatically scale an application.
*/
export interface Schema$Instance {
/**
* App Engine release this instance is running on.@OutputOnly
*/
appEngineRelease?: string;
/**
* Availability of the instance.@OutputOnly
*/
availability?: string;
/**
* Average latency (ms) over the last minute.@OutputOnly
*/
averageLatency?: number;
/**
* Number of errors since this instance was started.@OutputOnly
*/
errors?: number;
/**
* Relative name of the instance within the version. Example:
* instance-1.@OutputOnly
*/
id?: string;
/**
* Total memory in use (bytes).@OutputOnly
*/
memoryUsage?: string;
/**
* Full path to the Instance resource in the API. Example:
* apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly
*/
name?: string;
/**
* Average queries per second (QPS) over the last minute.@OutputOnly
*/
qps?: number;
/**
* Number of requests since this instance was started.@OutputOnly
*/
requests?: number;
/**
* Time that this instance was started.@OutputOnly
*/
startTimestamp?: string;
/**
* Virtual machine ID of this instance. Only applicable for instances in App
* Engine flexible environment.@OutputOnly
*/
vmId?: string;
/**
* The IP address of this instance. Only applicable for instances in App
* Engine flexible environment.@OutputOnly
*/
vmIp?: string;
/**
* Name of the virtual machine where this instance lives. Only applicable
* for instances in App Engine flexible environment.@OutputOnly
*/
vmName?: string;
/**
* Status of the virtual machine where this instance lives. Only applicable
* for instances in App Engine flexible environment.@OutputOnly
*/
vmStatus?: string;
/**
* Whether this instance is in debug mode. Only applicable for instances in
* App Engine flexible environment.@OutputOnly
*/
vmUnlocked?: boolean;
/**
* Zone where the virtual machine is located. Only applicable for instances
* in App Engine flexible environment.@OutputOnly
*/
vmZoneName?: string;
}
/**
* Third-party Python runtime library that is required by the application.
*/
export interface Schema$Library {
/**
* Name of the library. Example: "django".
*/
name?: string;
/**
* Version of the library to select, or "latest".
*/
version?: string;
}
/**
* Response message for Instances.ListInstances.
*/
export interface Schema$ListInstancesResponse {
/**
* The instances belonging to the requested version.
*/
instances?: Schema$Instance[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response message for Services.ListServices.
*/
export interface Schema$ListServicesResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
/**
* The services belonging to the requested application.
*/
services?: Schema$Service[];
}
/**
* Response message for Versions.ListVersions.
*/
export interface Schema$ListVersionsResponse {
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
/**
* The versions belonging to the requested service.
*/
versions?: Schema$Version[];
}
/**
* A resource that represents Google Cloud Platform location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: any;
/**
* The canonical id for this location. For example: "us-east1".
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the
* given location.
*/
metadata?: any;
/**
* Resource name for the location, which may vary between implementations.
* For example: "projects/example-project/locations/us-east1"
*/
name?: string;
}
/**
* Metadata for the given google.cloud.location.Location.
*/
export interface Schema$LocationMetadata {
/**
* App Engine flexible environment is available in the given
* location.@OutputOnly
*/
flexibleEnvironmentAvailable?: boolean;
/**
* App Engine standard environment is available in the given
* location.@OutputOnly
*/
standardEnvironmentAvailable?: boolean;
}
/**
* A service with manual scaling runs continuously, allowing you to perform
* complex initialization and rely on the state of its memory over time.
*/
export interface Schema$ManualScaling {
/**
* 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.
*/
instances?: number;
}
/**
* Extra network settings. Only applicable for VM runtimes.
*/
export interface Schema$Network {
/**
* List of ports, or port pairs, to forward from the virtual machine to the
* application container.
*/
forwardedPorts?: string[];
/**
* Tag to apply to the VM instance during creation.
*/
instanceTag?: string;
/**
* Google Cloud Platform network where the virtual machines are created.
* Specify the short name, not the resource path.Defaults to default.
*/
name?: 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 the VM instance is being created in is a
* Legacy network, then the IP address is allocated from the IPv4Range. If
* the network the VM 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
* the VM 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 Flex app.
*/
subnetworkName?: string;
}
/**
* Target scaling by network usage. Only applicable for VM runtimes.
*/
export interface Schema$NetworkUtilization {
/**
* Target bytes received per second.
*/
targetReceivedBytesPerSec?: number;
/**
* Target packets received per second.
*/
targetReceivedPacketsPerSec?: number;
/**
* Target bytes sent per second.
*/
targetSentBytesPerSec?: number;
/**
* Target packets sent per second.
*/
targetSentPacketsPerSec?: number;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: any;
/**
* 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 have the format of operations/some/unique/name.
*/
name?: string;
/**
* The normal response of the operation in case of success. 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.
*/
response?: any;
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadata {
/**
* Timestamp that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Timestamp that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1beta4.Version.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Type of this operation. Deprecated, use method field instead. Example:
* "create_version".@OutputOnly
*/
operationType?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/modules/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadataV1 {
createVersionMetadata?: Schema$CreateVersionMetadataV1;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadataV1Alpha {
createVersionMetadata?: Schema$CreateVersionMetadataV1Alpha;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadataV1Beta {
createVersionMetadata?: Schema$CreateVersionMetadataV1Beta;
/**
* Time that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Ephemeral message that may change every time the operation is polled.
* @OutputOnly
*/
ephemeralMessage?: string;
/**
* Time that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method that initiated this operation. Example:
* google.appengine.v1beta.Versions.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
/**
* Durable messages that persist on every operation poll. @OutputOnly
*/
warning?: string[];
}
/**
* Metadata for the given google.longrunning.Operation.
*/
export interface Schema$OperationMetadataV1Beta5 {
/**
* Timestamp that this operation completed.@OutputOnly
*/
endTime?: string;
/**
* Timestamp that this operation was created.@OutputOnly
*/
insertTime?: string;
/**
* API method name that initiated this operation. Example:
* google.appengine.v1beta5.Version.CreateVersion.@OutputOnly
*/
method?: string;
/**
* Name of the resource that this operation is acting on. Example:
* apps/myapp/services/default.@OutputOnly
*/
target?: string;
/**
* User who requested this operation.@OutputOnly
*/
user?: string;
}
/**
* Target scaling by request utilization. Only applicable for VM runtimes.
*/
export interface Schema$RequestUtilization {
/**
* Target number of concurrent requests.
*/
targetConcurrentRequests?: number;
/**
* Target requests per second.
*/
targetRequestCountPerSec?: number;
}
/**
* Machine resources for a version.
*/
export interface Schema$Resources {
/**
* Number of CPU cores needed.
*/
cpu?: number;
/**
* Disk size (GB) needed.
*/
diskGb?: number;
/**
* Memory (GB) needed.