v1beta1.d.ts
48.8 KB
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
/**
* Copyright 2019 Google LLC
*
* 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 { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace firebasehosting_v1beta1 {
export interface Options extends GlobalOptions {
version: 'v1beta1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Firebase Hosting API
*
* The Firebase Hosting REST API enables programmatic and customizable deployments to your Firebase-hosted sites. Use this REST API to deploy new or updated hosting configurations and content files.
*
* @example
* const {google} = require('googleapis');
* const firebasehosting = google.firebasehosting('v1beta1');
*
* @namespace firebasehosting
* @type {Function}
* @version v1beta1
* @variation v1beta1
* @param {object=} options Options for Firebasehosting
*/
export class Firebasehosting {
context: APIRequestContext;
sites: Resource$Sites;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Contains metadata about the user who performed an action, such as creating a release or finalizing a version.
*/
export interface Schema$ActingUser {
/**
* The email address of the user when the user performed the action.
*/
email?: string | null;
/**
* A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
*/
imageUrl?: string | null;
}
/**
* Represents a DNS certificate challenge.
*/
export interface Schema$CertDnsChallenge {
/**
* The domain name upon which the DNS challenge must be satisfied.
*/
domainName?: string | null;
/**
* The value that must be present as a TXT record on the domain name to satisfy the challenge.
*/
token?: string | null;
}
/**
* Represents an HTTP certificate challenge.
*/
export interface Schema$CertHttpChallenge {
/**
* The URL path on which to serve the specified token to satisfy the certificate challenge.
*/
path?: string | null;
/**
* The token to serve at the specified URL path to satisfy the certificate challenge.
*/
token?: string | null;
}
/**
* A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error).
*/
export interface Schema$CloudRunRewrite {
/**
* Optional. User-provided region where the Cloud Run service is hosted.<br> Defaults to `us-central1` if not supplied.
*/
region?: string | null;
/**
* Required. User-defined ID of the Cloud Run service.
*/
serviceId?: string | null;
}
/**
* The intended behavior and status information of a domain.
*/
export interface Schema$Domain {
/**
* Required. The domain name of the association.
*/
domainName?: string | null;
/**
* If set, the domain should redirect with the provided parameters.
*/
domainRedirect?: Schema$DomainRedirect;
/**
* Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.
*/
provisioning?: Schema$DomainProvisioning;
/**
* Required. The site name of the association.
*/
site?: string | null;
/**
* Output only. Additional status of the domain association.
*/
status?: string | null;
/**
* Output only. The time at which the domain was last updated.
*/
updateTime?: string | null;
}
/**
* The current certificate provisioning status information for a domain.
*/
export interface Schema$DomainProvisioning {
/**
* The TXT records (for the certificate challenge) that were found at the last DNS fetch.
*/
certChallengeDiscoveredTxt?: string[] | null;
/**
* The DNS challenge for generating a certificate.
*/
certChallengeDns?: Schema$CertDnsChallenge;
/**
* The HTTP challenge for generating a certificate.
*/
certChallengeHttp?: Schema$CertHttpChallenge;
/**
* The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.
*/
certStatus?: string | null;
/**
* The IPs found at the last DNS fetch.
*/
discoveredIps?: string[] | null;
/**
* The time at which the last DNS fetch occurred.
*/
dnsFetchTime?: string | null;
/**
* The DNS record match status as of the last DNS fetch.
*/
dnsStatus?: string | null;
/**
* The list of IPs to which the domain is expected to resolve.
*/
expectedIps?: string[] | null;
}
/**
* Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.
*/
export interface Schema$DomainRedirect {
/**
* Required. The domain name to redirect to.
*/
domainName?: string | null;
/**
* Required. The redirect status code.
*/
type?: string | null;
}
/**
* 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 {
}
/**
* A [`header`](/docs/hosting/full-config#headers) defines custom headers to add to a response should the request URL path match the pattern.
*/
export interface Schema$Header {
/**
* The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
*/
glob?: string | null;
/**
* Required. The additional headers to add to the response.
*/
headers?: {
[key: string]: string;
} | null;
/**
* The user-supplied RE2 regular expression to match against the request URL path.
*/
regex?: string | null;
}
export interface Schema$ListDomainsResponse {
/**
* The list of domains, if any exist.
*/
domains?: Schema$Domain[];
/**
* The pagination token, if more results exist.
*/
nextPageToken?: string | null;
}
export interface Schema$ListReleasesResponse {
/**
* If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases.
*/
nextPageToken?: string | null;
/**
* The list of hashes of files that still need to be uploaded, if any exist.
*/
releases?: Schema$Release[];
}
export interface Schema$ListVersionFilesResponse {
/**
* The list path/hashes in the specified version.
*/
files?: Schema$VersionFile[];
/**
* The pagination token, if more results exist.
*/
nextPageToken?: string | null;
}
export interface Schema$PopulateVersionFilesRequest {
/**
* A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file.
*/
files?: {
[key: string]: string;
} | null;
}
export interface Schema$PopulateVersionFilesResponse {
/**
* The content hashes of the specified files that need to be uploaded to the specified endpoint.
*/
uploadRequiredHashes?: string[] | null;
/**
* The URL to which the files should be uploaded, in the format: <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name</var>/versions/<var>versionID</var>/files". <br>Perform a multipart `POST` of the Gzipped file contents to the URL using a forward slash and the hash of the file appended to the end.
*/
uploadUrl?: string | null;
}
/**
* Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version.
*/
export interface Schema$PreviewConfig {
/**
* If true, preview URLs are enabled for this version.
*/
active?: boolean | null;
/**
* Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
*/
expireTime?: string | null;
}
/**
* A [`redirect`](/docs/hosting/full-config#redirects) represents the configuration for returning an HTTP redirect response given a matching request URL path.
*/
export interface Schema$Redirect {
/**
* The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
*/
glob?: string | null;
/**
* Required. The value to put in the HTTP location header of the response. <br>The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: <code>"glob": "/:capture*", <br>"statusCode": 301, <br>"location": "https://example.com/foo/:capture"</code>
*/
location?: string | null;
/**
* The user-supplied RE2 regular expression to match against the request URL path.
*/
regex?: string | null;
/**
* Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
*/
statusCode?: number | null;
}
/**
* A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.
*/
export interface Schema$Release {
/**
* The deploy description when the release was created. The value can be up to 512&nbsp;characters.
*/
message?: string | null;
/**
* Output only. The unique identifier for the release, in the format: <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code> This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.
*/
name?: string | null;
/**
* Output only. The time at which the version is set to be public.
*/
releaseTime?: string | null;
/**
* Output only. Identifies the user who created the release.
*/
releaseUser?: Schema$ActingUser;
/**
* Explains the reason for the release. <br>Specify a value for this field only when creating a `SITE_DISABLE` type release.
*/
type?: string | null;
/**
* Output only. The configuration and content that was released.
*/
version?: Schema$Version;
}
/**
* A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal content rewrite on the version. If the pattern matches, the request will be handled as if it were to the destination path specified in the configuration.
*/
export interface Schema$Rewrite {
/**
* The request will be forwarded to Firebase Dynamic Links.
*/
dynamicLinks?: boolean | null;
/**
* The function to proxy requests to. Must match the exported function name exactly.
*/
function?: string | null;
/**
* The user-supplied [glob pattern](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
*/
glob?: string | null;
/**
* The URL path to rewrite the request to.
*/
path?: string | null;
/**
* The user-supplied RE2 regular expression to match against the request URL path.
*/
regex?: string | null;
/**
* The request will be forwarded to Cloud Run.
*/
run?: Schema$CloudRunRewrite;
}
/**
* The configuration for how incoming requests to a site should be routed and processed before serving content. The patterns are matched and applied according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order).
*/
export interface Schema$ServingConfig {
/**
* How to handle well known App Association files.
*/
appAssociation?: string | null;
/**
* Defines whether to drop the file extension from uploaded files.
*/
cleanUrls?: boolean | null;
/**
* A list of custom response headers that are added to the content if the request URL path matches the glob.
*/
headers?: Schema$Header[];
/**
* A list of globs that will cause the response to redirect to another location.
*/
redirects?: Schema$Redirect[];
/**
* A list of rewrites that will act as if the service were given the destination URL.
*/
rewrites?: Schema$Rewrite[];
/**
* Defines how to handle a trailing slash in the URL path.
*/
trailingSlashBehavior?: string | null;
}
/**
* A `SiteConfig` contains metadata associated with a specific site that controls Firebase Hosting serving behavior
*/
export interface Schema$SiteConfig {
/**
* The number of FINALIZED versions that will be held for a site before automatic deletion. When a new version is deployed, content for versions in storage in excess of this number will be deleted, and will no longer be billed for storage usage. Oldest versions will be deleted first; sites are created with an unlimited number of max_versions by default.
*/
maxVersions?: string | null;
}
/**
* A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed.
*/
export interface Schema$Version {
/**
* The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
*/
config?: Schema$ServingConfig;
/**
* Output only. The time at which the version was created.
*/
createTime?: string | null;
/**
* Output only. Identifies the user who created the version.
*/
createUser?: Schema$ActingUser;
/**
* Output only. The time at which the version was `DELETED`.
*/
deleteTime?: string | null;
/**
* Output only. Identifies the user who `DELETED` the version.
*/
deleteUser?: Schema$ActingUser;
/**
* Output only. The total number of files associated with the version. <br>This value is calculated after a version is `FINALIZED`.
*/
fileCount?: string | null;
/**
* Output only. The time at which the version was `FINALIZED`.
*/
finalizeTime?: string | null;
/**
* Output only. Identifies the user who `FINALIZED` the version.
*/
finalizeUser?: Schema$ActingUser;
/**
* The labels used for extra metadata and/or filtering.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
*/
name?: string | null;
/**
* Version preview configuration for the site version. This configuration specfies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
*/
preview?: Schema$PreviewConfig;
/**
* The deploy status of a version. <br> <br>For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. <br> <br>Note that if you leave the version in the `CREATED` state for more than 12&nbsp;hours, the system will automatically mark the version as `ABANDONED`. <br> <br>You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.
*/
status?: string | null;
/**
* Output only. The total stored bytesize of the version. <br>This value is calculated after a version is `FINALIZED`.
*/
versionBytes?: string | null;
}
/**
* A static content file that is part of a version.
*/
export interface Schema$VersionFile {
/**
* The SHA256 content hash of the file.
*/
hash?: string | null;
/**
* The URI at which the file's content should display.
*/
path?: string | null;
/**
* Output only. The current status of a particular file in the specified version. <br>The value will be either `pending upload` or `uploaded`.
*/
status?: string | null;
}
export class Resource$Sites {
context: APIRequestContext;
domains: Resource$Sites$Domains;
releases: Resource$Sites$Releases;
versions: Resource$Sites$Versions;
constructor(context: APIRequestContext);
/**
* firebasehosting.sites.getConfig
* @desc Gets the Hosting metadata for a specific site.
* @alias firebasehosting.sites.getConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The site for which to get the SiteConfig, in the format: <code>sites/<var>site-name</var>/config</code>
* @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
*/
getConfig(params?: Params$Resource$Sites$Getconfig, options?: MethodOptions): GaxiosPromise<Schema$SiteConfig>;
getConfig(params: Params$Resource$Sites$Getconfig, options: MethodOptions | BodyResponseCallback<Schema$SiteConfig>, callback: BodyResponseCallback<Schema$SiteConfig>): void;
getConfig(params: Params$Resource$Sites$Getconfig, callback: BodyResponseCallback<Schema$SiteConfig>): void;
getConfig(callback: BodyResponseCallback<Schema$SiteConfig>): void;
/**
* firebasehosting.sites.updateConfig
* @desc Sets the Hosting metadata for a specific site.
* @alias firebasehosting.sites.updateConfig
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The site for which to update the SiteConfig, in the format: <code>sites/<var>site-name</var>/config</code>
* @param {string=} params.updateMask A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. <br>A field will be overwritten if, and only if, it's in the mask. <br>If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.
* @param {().SiteConfig} 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
*/
updateConfig(params?: Params$Resource$Sites$Updateconfig, options?: MethodOptions): GaxiosPromise<Schema$SiteConfig>;
updateConfig(params: Params$Resource$Sites$Updateconfig, options: MethodOptions | BodyResponseCallback<Schema$SiteConfig>, callback: BodyResponseCallback<Schema$SiteConfig>): void;
updateConfig(params: Params$Resource$Sites$Updateconfig, callback: BodyResponseCallback<Schema$SiteConfig>): void;
updateConfig(callback: BodyResponseCallback<Schema$SiteConfig>): void;
}
export interface Params$Resource$Sites$Getconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The site for which to get the SiteConfig, in the format: <code>sites/<var>site-name</var>/config</code>
*/
name?: string;
}
export interface Params$Resource$Sites$Updateconfig extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The site for which to update the SiteConfig, in the format: <code>sites/<var>site-name</var>/config</code>
*/
name?: string;
/**
* A set of field names from your [site configuration](../sites.SiteConfig) that you want to update. <br>A field will be overwritten if, and only if, it's in the mask. <br>If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$SiteConfig;
}
export class Resource$Sites$Domains {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebasehosting.sites.domains.create
* @desc Creates a domain mapping on the specified site.
* @alias firebasehosting.sites.domains.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The parent to create the domain association for, in the format: <code>sites/<var>site-name</var></code>
* @param {().Domain} 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$Sites$Domains$Create, options?: MethodOptions): GaxiosPromise<Schema$Domain>;
create(params: Params$Resource$Sites$Domains$Create, options: MethodOptions | BodyResponseCallback<Schema$Domain>, callback: BodyResponseCallback<Schema$Domain>): void;
create(params: Params$Resource$Sites$Domains$Create, callback: BodyResponseCallback<Schema$Domain>): void;
create(callback: BodyResponseCallback<Schema$Domain>): void;
/**
* firebasehosting.sites.domains.delete
* @desc Deletes the existing domain mapping on the specified site.
* @alias firebasehosting.sites.domains.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the domain association to delete.
* @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$Sites$Domains$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Sites$Domains$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Sites$Domains$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* firebasehosting.sites.domains.get
* @desc Gets a domain mapping on the specified site.
* @alias firebasehosting.sites.domains.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the domain configuration to get.
* @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$Sites$Domains$Get, options?: MethodOptions): GaxiosPromise<Schema$Domain>;
get(params: Params$Resource$Sites$Domains$Get, options: MethodOptions | BodyResponseCallback<Schema$Domain>, callback: BodyResponseCallback<Schema$Domain>): void;
get(params: Params$Resource$Sites$Domains$Get, callback: BodyResponseCallback<Schema$Domain>): void;
get(callback: BodyResponseCallback<Schema$Domain>): void;
/**
* firebasehosting.sites.domains.list
* @desc Lists the domains for the specified site.
* @alias firebasehosting.sites.domains.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The page size to return. Defaults to 50.
* @param {string=} params.pageToken The next_page_token from a previous request, if provided.
* @param {string} params.parent Required. The parent for which to list domains, in the format: <code>sites/<var>site-name</var></code>
* @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$Sites$Domains$List, options?: MethodOptions): GaxiosPromise<Schema$ListDomainsResponse>;
list(params: Params$Resource$Sites$Domains$List, options: MethodOptions | BodyResponseCallback<Schema$ListDomainsResponse>, callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
list(params: Params$Resource$Sites$Domains$List, callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDomainsResponse>): void;
/**
* firebasehosting.sites.domains.update
* @desc Updates the specified domain mapping, creating the mapping as if it does not exist.
* @alias firebasehosting.sites.domains.update
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the domain association to update or create, if an association doesn't already exist.
* @param {().Domain} 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
*/
update(params?: Params$Resource$Sites$Domains$Update, options?: MethodOptions): GaxiosPromise<Schema$Domain>;
update(params: Params$Resource$Sites$Domains$Update, options: MethodOptions | BodyResponseCallback<Schema$Domain>, callback: BodyResponseCallback<Schema$Domain>): void;
update(params: Params$Resource$Sites$Domains$Update, callback: BodyResponseCallback<Schema$Domain>): void;
update(callback: BodyResponseCallback<Schema$Domain>): void;
}
export interface Params$Resource$Sites$Domains$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The parent to create the domain association for, in the format: <code>sites/<var>site-name</var></code>
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Domain;
}
export interface Params$Resource$Sites$Domains$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the domain association to delete.
*/
name?: string;
}
export interface Params$Resource$Sites$Domains$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the domain configuration to get.
*/
name?: string;
}
export interface Params$Resource$Sites$Domains$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The page size to return. Defaults to 50.
*/
pageSize?: number;
/**
* The next_page_token from a previous request, if provided.
*/
pageToken?: string;
/**
* Required. The parent for which to list domains, in the format: <code>sites/<var>site-name</var></code>
*/
parent?: string;
}
export interface Params$Resource$Sites$Domains$Update extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the domain association to update or create, if an association doesn't already exist.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Domain;
}
export class Resource$Sites$Releases {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebasehosting.sites.releases.create
* @desc Creates a new release which makes the content of the specified version actively display on the site.
* @alias firebasehosting.sites.releases.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent The site that the release belongs to, in the format: <code>sites/<var>site-name</var></code>
* @param {string=} params.versionName The unique identifier for a version, in the format: <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code> The <var>site-name</var> in this version identifier must match the <var>site-name</var> in the `parent` parameter. <br> <br>This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.
* @param {().Release} 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$Sites$Releases$Create, options?: MethodOptions): GaxiosPromise<Schema$Release>;
create(params: Params$Resource$Sites$Releases$Create, options: MethodOptions | BodyResponseCallback<Schema$Release>, callback: BodyResponseCallback<Schema$Release>): void;
create(params: Params$Resource$Sites$Releases$Create, callback: BodyResponseCallback<Schema$Release>): void;
create(callback: BodyResponseCallback<Schema$Release>): void;
/**
* firebasehosting.sites.releases.list
* @desc Lists the releases that have been created on the specified site.
* @alias firebasehosting.sites.releases.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The page size to return. Defaults to 100.
* @param {string=} params.pageToken The next_page_token from a previous request, if provided.
* @param {string} params.parent Required. The parent for which to list files, in the format: <code>sites/<var>site-name</var></code>
* @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$Sites$Releases$List, options?: MethodOptions): GaxiosPromise<Schema$ListReleasesResponse>;
list(params: Params$Resource$Sites$Releases$List, options: MethodOptions | BodyResponseCallback<Schema$ListReleasesResponse>, callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
list(params: Params$Resource$Sites$Releases$List, callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListReleasesResponse>): void;
}
export interface Params$Resource$Sites$Releases$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The site that the release belongs to, in the format: <code>sites/<var>site-name</var></code>
*/
parent?: string;
/**
* The unique identifier for a version, in the format: <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code> The <var>site-name</var> in this version identifier must match the <var>site-name</var> in the `parent` parameter. <br> <br>This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.
*/
versionName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Release;
}
export interface Params$Resource$Sites$Releases$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The page size to return. Defaults to 100.
*/
pageSize?: number;
/**
* The next_page_token from a previous request, if provided.
*/
pageToken?: string;
/**
* Required. The parent for which to list files, in the format: <code>sites/<var>site-name</var></code>
*/
parent?: string;
}
export class Resource$Sites$Versions {
context: APIRequestContext;
files: Resource$Sites$Versions$Files;
constructor(context: APIRequestContext);
/**
* firebasehosting.sites.versions.create
* @desc Creates a new version for a site.
* @alias firebasehosting.sites.versions.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The parent to create the version for, in the format: <code>sites/<var>site-name</var></code>
* @param {string=} params.sizeBytes The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.
* @param {string=} params.versionId A unique id for the new version. This is only specified for legacy version creations.
* @param {().Version} 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$Sites$Versions$Create, options?: MethodOptions): GaxiosPromise<Schema$Version>;
create(params: Params$Resource$Sites$Versions$Create, options: MethodOptions | BodyResponseCallback<Schema$Version>, callback: BodyResponseCallback<Schema$Version>): void;
create(params: Params$Resource$Sites$Versions$Create, callback: BodyResponseCallback<Schema$Version>): void;
create(callback: BodyResponseCallback<Schema$Version>): void;
/**
* firebasehosting.sites.versions.delete
* @desc Deletes the specified version.
* @alias firebasehosting.sites.versions.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The name of the version to be deleted, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
* @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$Sites$Versions$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Sites$Versions$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Sites$Versions$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* firebasehosting.sites.versions.patch
* @desc Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`.
* @alias firebasehosting.sites.versions.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
* @param {string=} params.updateMask A set of field names from your [version](../sites.versions) that you want to update. <br>A field will be overwritten if, and only if, it's in the mask. <br>If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.
* @param {().Version} 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
*/
patch(params?: Params$Resource$Sites$Versions$Patch, options?: MethodOptions): GaxiosPromise<Schema$Version>;
patch(params: Params$Resource$Sites$Versions$Patch, options: MethodOptions | BodyResponseCallback<Schema$Version>, callback: BodyResponseCallback<Schema$Version>): void;
patch(params: Params$Resource$Sites$Versions$Patch, callback: BodyResponseCallback<Schema$Version>): void;
patch(callback: BodyResponseCallback<Schema$Version>): void;
/**
* firebasehosting.sites.versions.populateFiles
* @desc Adds content files to a version.
* @alias firebasehosting.sites.versions.populateFiles
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.parent Required. The version to add files to, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
* @param {().PopulateVersionFilesRequest} 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
*/
populateFiles(params?: Params$Resource$Sites$Versions$Populatefiles, options?: MethodOptions): GaxiosPromise<Schema$PopulateVersionFilesResponse>;
populateFiles(params: Params$Resource$Sites$Versions$Populatefiles, options: MethodOptions | BodyResponseCallback<Schema$PopulateVersionFilesResponse>, callback: BodyResponseCallback<Schema$PopulateVersionFilesResponse>): void;
populateFiles(params: Params$Resource$Sites$Versions$Populatefiles, callback: BodyResponseCallback<Schema$PopulateVersionFilesResponse>): void;
populateFiles(callback: BodyResponseCallback<Schema$PopulateVersionFilesResponse>): void;
}
export interface Params$Resource$Sites$Versions$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The parent to create the version for, in the format: <code>sites/<var>site-name</var></code>
*/
parent?: string;
/**
* The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads.
*/
sizeBytes?: string;
/**
* A unique id for the new version. This is only specified for legacy version creations.
*/
versionId?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Version;
}
export interface Params$Resource$Sites$Versions$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The name of the version to be deleted, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
*/
name?: string;
}
export interface Params$Resource$Sites$Versions$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The unique identifier for a version, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.
*/
name?: string;
/**
* A set of field names from your [version](../sites.versions) that you want to update. <br>A field will be overwritten if, and only if, it's in the mask. <br>If a mask is not provided then a default mask of only [`status`](../sites.versions#Version.FIELDS.status) will be used.
*/
updateMask?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Version;
}
export interface Params$Resource$Sites$Versions$Populatefiles extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The version to add files to, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
*/
parent?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PopulateVersionFilesRequest;
}
export class Resource$Sites$Versions$Files {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* firebasehosting.sites.versions.files.list
* @desc Lists the remaining files to be uploaded for the specified version.
* @alias firebasehosting.sites.versions.files.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {integer=} params.pageSize The page size to return. Defaults to 1000.
* @param {string=} params.pageToken The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
* @param {string} params.parent Required. The parent to list files for, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
* @param {string=} params.status The type of files in the version that should be listed.
* @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$Sites$Versions$Files$List, options?: MethodOptions): GaxiosPromise<Schema$ListVersionFilesResponse>;
list(params: Params$Resource$Sites$Versions$Files$List, options: MethodOptions | BodyResponseCallback<Schema$ListVersionFilesResponse>, callback: BodyResponseCallback<Schema$ListVersionFilesResponse>): void;
list(params: Params$Resource$Sites$Versions$Files$List, callback: BodyResponseCallback<Schema$ListVersionFilesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListVersionFilesResponse>): void;
}
export interface Params$Resource$Sites$Versions$Files$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The page size to return. Defaults to 1000.
*/
pageSize?: number;
/**
* The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
*/
pageToken?: string;
/**
* Required. The parent to list files for, in the format: <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
*/
parent?: string;
/**
* The type of files in the version that should be listed.
*/
status?: string;
}
export {};
}