/
v1alpha.ts
2151 lines (2024 loc) · 77.5 KB
/
v1alpha.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 {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace appengine_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
/**
* 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('v1alpha');
*
* @namespace appengine
* @type {Function}
* @version v1alpha
* @variation v1alpha
* @param {object=} options Options for Appengine
*/
export class Appengine {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
apps: Resource$Apps;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.apps = new Resource$Apps(this);
}
getRoot() {
return this.root;
}
}
/**
* An SSL certificate that a user has been authorized to administer. A user is
* authorized to administer any certificate that applies to one of their
* authorized domains.
*/
export interface Schema$AuthorizedCertificate {
/**
* The SSL certificate serving the AuthorizedCertificate resource. This must
* be obtained independently from a certificate authority.
*/
certificateRawData?: Schema$CertificateRawData;
/**
* The user-specified display name of the certificate. This is not
* guaranteed to be unique. Example: My Certificate.
*/
displayName?: string;
/**
* Aggregate count of the domain mappings with this certificate mapped. This
* count includes domain mappings on applications for which the user does
* not have VIEWER permissions.Only returned by GET or LIST requests when
* specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly
*/
domainMappingsCount?: number;
/**
* Topmost applicable domains of this certificate. This certificate applies
* to these domains and their subdomains. Example: example.com.@OutputOnly
*/
domainNames?: string[];
/**
* The time when this certificate expires. To update the renewal time on
* this certificate, upload an SSL certificate with a different expiration
* time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly
*/
expireTime?: string;
/**
* Relative name of the certificate. This is a unique value autogenerated on
* AuthorizedCertificate resource creation. Example: 12345.@OutputOnly
*/
id?: string;
/**
* Only applicable if this certificate is managed by App Engine. Managed
* certificates are tied to the lifecycle of a DomainMapping and cannot be
* updated or deleted via the AuthorizedCertificates API. If this
* certificate is manually administered by the user, this field will be
* empty.@OutputOnly
*/
managedCertificate?: Schema$ManagedCertificate;
/**
* Full path to the AuthorizedCertificate resource in the API. Example:
* apps/myapp/authorizedCertificates/12345.@OutputOnly
*/
name?: string;
/**
* The full paths to user visible Domain Mapping resources that have this
* certificate mapped. Example: apps/myapp/domainMappings/example.com.This
* may not represent the full list of mapped domain mappings if the user
* does not have VIEWER permissions on all of the applications that have
* this certificate mapped. See domain_mappings_count for a complete
* count.Only returned by GET or LIST requests when specifically requested
* by the view=FULL_CERTIFICATE option.@OutputOnly
*/
visibleDomainMappings?: string[];
}
/**
* A domain that a user has been authorized to administer. To authorize use of
* a domain, verify ownership via Webmaster Central
* (https://www.google.com/webmasters/verification/home).
*/
export interface Schema$AuthorizedDomain {
/**
* Fully qualified domain name of the domain authorized for use. Example:
* example.com.
*/
id?: string;
/**
* Full path to the AuthorizedDomain resource in the API. Example:
* apps/myapp/authorizedDomains/example.com.@OutputOnly
*/
name?: string;
}
/**
* An SSL certificate obtained from a certificate authority.
*/
export interface Schema$CertificateRawData {
/**
* Unencrypted PEM encoded RSA private key. This field is set once on
* certificate creation and then encrypted. The key size must be 2048 bits
* or fewer. Must include the header and footer. Example: <pre>
* -----BEGIN RSA PRIVATE KEY----- <unencrypted_key_value> -----END
* RSA PRIVATE KEY----- </pre> @InputOnly
*/
privateKey?: string;
/**
* PEM encoded x.509 public key certificate. This field is set once on
* certificate creation. Must include the header and footer. Example:
* <pre> -----BEGIN CERTIFICATE----- <certificate_value>
* -----END CERTIFICATE----- </pre>
*/
publicCertificate?: string;
}
/**
* 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;
}
/**
* A domain serving an App Engine application.
*/
export interface Schema$DomainMapping {
/**
* Relative name of the domain serving the application. Example:
* example.com.
*/
id?: string;
/**
* Full path to the DomainMapping resource in the API. Example:
* apps/myapp/domainMapping/example.com.@OutputOnly
*/
name?: string;
/**
* The resource records required to configure this domain mapping. These
* records must be added to the domain's DNS configuration in order to
* serve the application via this domain mapping.@OutputOnly
*/
resourceRecords?: Schema$ResourceRecord[];
/**
* SSL configuration for this domain. If unconfigured, this domain will not
* serve with SSL.
*/
sslSettings?: Schema$SslSettings;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for Empty is empty JSON object {}.
*/
export interface Schema$Empty {}
/**
* Response message for AuthorizedCertificates.ListAuthorizedCertificates.
*/
export interface Schema$ListAuthorizedCertificatesResponse {
/**
* The SSL certificates the user is authorized to administer.
*/
certificates?: Schema$AuthorizedCertificate[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for AuthorizedDomains.ListAuthorizedDomains.
*/
export interface Schema$ListAuthorizedDomainsResponse {
/**
* The authorized domains belonging to the user.
*/
domains?: Schema$AuthorizedDomain[];
/**
* Continuation token for fetching the next page of results.
*/
nextPageToken?: string;
}
/**
* Response message for DomainMappings.ListDomainMappings.
*/
export interface Schema$ListDomainMappingsResponse {
/**
* The domain mappings for the application.
*/
domainMappings?: Schema$DomainMapping[];
/**
* 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[];
}
/**
* 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 certificate managed by App Engine.
*/
export interface Schema$ManagedCertificate {
/**
* Time at which the certificate was last renewed. The renewal process is
* fully managed. Certificate renewal will automatically occur before the
* certificate expires. Renewal errors can be tracked via
* ManagementStatus.@OutputOnly
*/
lastRenewalTime?: string;
/**
* Status of certificate management. Refers to the most recent certificate
* acquisition or renewal attempt.@OutputOnly
*/
status?: string;
}
/**
* 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;
}
/**
* A DNS resource record.
*/
export interface Schema$ResourceRecord {
/**
* Relative name of the object affected by this record. Only applicable for
* CNAME records. Example: 'www'.
*/
name?: string;
/**
* Data for this record. Values vary by record type, as defined in RFC 1035
* (section 5) and RFC 1034 (section 3.6.1).
*/
rrdata?: string;
/**
* Resource record type. Example: AAAA.
*/
type?: string;
}
/**
* SSL configuration for a DomainMapping resource.
*/
export interface Schema$SslSettings {
/**
* ID of the AuthorizedCertificate resource configuring SSL for the
* application. Clearing this field will remove SSL support.By default, a
* managed certificate is automatically created for every domain mapping. To
* omit SSL support or to configure SSL manually, specify
* no_managed_certificate on a CREATE or UPDATE request. You must be
* authorized to administer the AuthorizedCertificate resource to manually
* map it to a DomainMapping resource. Example: 12345.
*/
certificateId?: string;
/**
* Whether the mapped certificate is an App Engine managed certificate.
* Managed certificates are created by default with a domain mapping. To opt
* out, specify no_managed_certificate on a CREATE or UPDATE
* request.@OutputOnly
*/
isManagedCertificate?: boolean;
}
/**
* 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). The error model is designed to be:
* Simple to use and understand for most users Flexible enough to meet
* unexpected needsOverviewThe Status message contains three pieces of data:
* error code, error message, and error details. The error code should be an
* enum value of google.rpc.Code, but it may accept additional error codes if
* needed. The error message should be a developer-facing English message that
* helps developers understand and resolve the error. If a localized
* user-facing error message is needed, put the localized message in the error
* details or localize it in the client. The optional error details may
* contain arbitrary information about the error. There is a predefined set of
* error detail types in the package google.rpc that can be used for common
* error conditions.Language mappingThe Status message is the logical
* representation of the error model, but it is not necessarily the actual
* wire format. When the Status message is exposed in different client
* libraries and different wire protocols, it can be mapped differently. For
* example, it will likely be mapped to some exceptions in Java, but more
* likely mapped to some error codes in C.Other usesThe error model and the
* Status message can be used in a variety of environments, either with or
* without APIs, to provide a consistent developer experience across different
* environments.Example uses of this error model include: Partial errors. If a
* service needs to return partial errors to the client, it may embed the
* Status in the normal response to indicate the partial errors. Workflow
* errors. A typical workflow has multiple steps. Each step may have a Status
* message for error reporting. Batch operations. If a client uses batch
* request and batch response, the Status message should be used directly
* inside batch response, one for each error sub-response. Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should be represented directly
* using the Status message. Logging. If some API errors are stored in logs,
* the message Status could be used directly after any stripping needed for
* security/privacy reasons.
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*/
details?: any[];
/**
* 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.
*/
message?: string;
}
export class Resource$Apps {
root: Appengine;
authorizedCertificates: Resource$Apps$Authorizedcertificates;
authorizedDomains: Resource$Apps$Authorizeddomains;
domainMappings: Resource$Apps$Domainmappings;
locations: Resource$Apps$Locations;
operations: Resource$Apps$Operations;
constructor(root: Appengine) {
this.root = root;
this.getRoot.bind(this);
this.authorizedCertificates =
new Resource$Apps$Authorizedcertificates(root);
this.authorizedDomains = new Resource$Apps$Authorizeddomains(root);
this.domainMappings = new Resource$Apps$Domainmappings(root);
this.locations = new Resource$Apps$Locations(root);
this.operations = new Resource$Apps$Operations(root);
}
getRoot() {
return this.root;
}
}
export class Resource$Apps$Authorizedcertificates {
root: Appengine;
constructor(root: Appengine) {
this.root = root;
this.getRoot.bind(this);
}
getRoot() {
return this.root;
}
/**
* appengine.apps.authorizedCertificates.create
* @desc Uploads the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {().AuthorizedCertificate} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(
params?: Params$Resource$Apps$Authorizedcertificates$Create,
options?: MethodOptions): AxiosPromise<Schema$AuthorizedCertificate>;
create(
params: Params$Resource$Apps$Authorizedcertificates$Create,
options: MethodOptions|
BodyResponseCallback<Schema$AuthorizedCertificate>,
callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
create(
params: Params$Resource$Apps$Authorizedcertificates$Create,
callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
create(callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
create(
paramsOrCallback?: Params$Resource$Apps$Authorizedcertificates$Create|
BodyResponseCallback<Schema$AuthorizedCertificate>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$AuthorizedCertificate>,
callback?: BodyResponseCallback<Schema$AuthorizedCertificate>):
void|AxiosPromise<Schema$AuthorizedCertificate> {
let params = (paramsOrCallback || {}) as
Params$Resource$Apps$Authorizedcertificates$Create;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Apps$Authorizedcertificates$Create;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1alpha/apps/{appsId}/authorizedCertificates')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'POST'
},
options),
params,
requiredParams: ['appsId'],
pathParams: ['appsId'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$AuthorizedCertificate>(parameters, callback);
} else {
return createAPIRequest<Schema$AuthorizedCertificate>(parameters);
}
}
/**
* appengine.apps.authorizedCertificates.delete
* @desc Deletes the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.
* @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(
params?: Params$Resource$Apps$Authorizedcertificates$Delete,
options?: MethodOptions): AxiosPromise<Schema$Empty>;
delete(
params: Params$Resource$Apps$Authorizedcertificates$Delete,
options: MethodOptions|BodyResponseCallback<Schema$Empty>,
callback: BodyResponseCallback<Schema$Empty>): void;
delete(
params: Params$Resource$Apps$Authorizedcertificates$Delete,
callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
delete(
paramsOrCallback?: Params$Resource$Apps$Authorizedcertificates$Delete|
BodyResponseCallback<Schema$Empty>,
optionsOrCallback?: MethodOptions|BodyResponseCallback<Schema$Empty>,
callback?: BodyResponseCallback<Schema$Empty>):
void|AxiosPromise<Schema$Empty> {
let params = (paramsOrCallback || {}) as
Params$Resource$Apps$Authorizedcertificates$Delete;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Apps$Authorizedcertificates$Delete;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/';
const parameters = {
options: Object.assign(
{
url:
(rootUrl +
'/v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'DELETE'
},
options),
params,
requiredParams: ['appsId', 'authorizedCertificatesId'],
pathParams: ['appsId', 'authorizedCertificatesId'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$Empty>(parameters, callback);
} else {
return createAPIRequest<Schema$Empty>(parameters);
}
}
/**
* appengine.apps.authorizedCertificates.get
* @desc Gets the specified SSL certificate.
* @alias appengine.apps.authorizedCertificates.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.
* @param {string} params.authorizedCertificatesId Part of `name`. See documentation of `appsId`.
* @param {string=} params.view Controls the set of fields returned in the GET response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Apps$Authorizedcertificates$Get,
options?: MethodOptions): AxiosPromise<Schema$AuthorizedCertificate>;
get(params: Params$Resource$Apps$Authorizedcertificates$Get,
options: MethodOptions|
BodyResponseCallback<Schema$AuthorizedCertificate>,
callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
get(params: Params$Resource$Apps$Authorizedcertificates$Get,
callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
get(callback: BodyResponseCallback<Schema$AuthorizedCertificate>): void;
get(paramsOrCallback?: Params$Resource$Apps$Authorizedcertificates$Get|
BodyResponseCallback<Schema$AuthorizedCertificate>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$AuthorizedCertificate>,
callback?: BodyResponseCallback<Schema$AuthorizedCertificate>):
void|AxiosPromise<Schema$AuthorizedCertificate> {
let params = (paramsOrCallback || {}) as
Params$Resource$Apps$Authorizedcertificates$Get;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Apps$Authorizedcertificates$Get;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/';
const parameters = {
options: Object.assign(
{
url:
(rootUrl +
'/v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['appsId', 'authorizedCertificatesId'],
pathParams: ['appsId', 'authorizedCertificatesId'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$AuthorizedCertificate>(parameters, callback);
} else {
return createAPIRequest<Schema$AuthorizedCertificate>(parameters);
}
}
/**
* appengine.apps.authorizedCertificates.list
* @desc Lists all SSL certificates the user is authorized to administer.
* @alias appengine.apps.authorizedCertificates.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `parent`. Name of the parent Application resource. Example: apps/myapp.
* @param {integer=} params.pageSize Maximum results to return per page.
* @param {string=} params.pageToken Continuation token for fetching the next page of results.
* @param {string=} params.view Controls the set of fields returned in the LIST response.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(
params?: Params$Resource$Apps$Authorizedcertificates$List,
options?: MethodOptions):
AxiosPromise<Schema$ListAuthorizedCertificatesResponse>;
list(
params: Params$Resource$Apps$Authorizedcertificates$List,
options: MethodOptions|
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>,
callback:
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>):
void;
list(
params: Params$Resource$Apps$Authorizedcertificates$List,
callback:
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>):
void;
list(callback:
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>):
void;
list(
paramsOrCallback?: Params$Resource$Apps$Authorizedcertificates$List|
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>,
optionsOrCallback?: MethodOptions|
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>,
callback?:
BodyResponseCallback<Schema$ListAuthorizedCertificatesResponse>):
void|AxiosPromise<Schema$ListAuthorizedCertificatesResponse> {
let params = (paramsOrCallback || {}) as
Params$Resource$Apps$Authorizedcertificates$List;
let options = (optionsOrCallback || {}) as MethodOptions;
if (typeof paramsOrCallback === 'function') {
callback = paramsOrCallback;
params = {} as Params$Resource$Apps$Authorizedcertificates$List;
options = {};
}
if (typeof optionsOrCallback === 'function') {
callback = optionsOrCallback;
options = {};
}
const rootUrl = options.rootUrl || 'https://appengine.googleapis.com/';
const parameters = {
options: Object.assign(
{
url: (rootUrl + '/v1alpha/apps/{appsId}/authorizedCertificates')
.replace(/([^:]\/)\/+/g, '$1'),
method: 'GET'
},
options),
params,
requiredParams: ['appsId'],
pathParams: ['appsId'],
context: this.getRoot()
};
if (callback) {
createAPIRequest<Schema$ListAuthorizedCertificatesResponse>(
parameters, callback);
} else {
return createAPIRequest<Schema$ListAuthorizedCertificatesResponse>(
parameters);
}
}
/**
* appengine.apps.authorizedCertificates.patch
* @desc Updates the specified SSL certificate. To renew a certificate and
* maintain its existing domain mappings, update certificate_data with a new
* certificate. The new certificate must be applicable to the same domains
* as the original certificate. The certificate display_name may also be
* updated.
* @alias appengine.apps.authorizedCertificates.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.appsId Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.