-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
Copy pathfirebasehosting-gen.go
3517 lines (3199 loc) · 120 KB
/
firebasehosting-gen.go
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 2019 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package firebasehosting provides access to the Firebase Hosting API.
//
// For product documentation, see: https://firebase.google.com/docs/hosting/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/firebasehosting/v1beta1"
// ...
// ctx := context.Background()
// firebasehostingService, err := firebasehosting.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
//
// firebasehostingService, err := firebasehosting.NewService(ctx, option.WithScopes(firebasehosting.FirebaseReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// firebasehostingService, err := firebasehosting.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// firebasehostingService, err := firebasehosting.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package firebasehosting // import "google.golang.org/api/firebasehosting/v1beta1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
gensupport "google.golang.org/api/gensupport"
googleapi "google.golang.org/api/googleapi"
option "google.golang.org/api/option"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
const apiId = "firebasehosting:v1beta1"
const apiName = "firebasehosting"
const apiVersion = "v1beta1"
const basePath = "https://firebasehosting.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// View and manage your data across Google Cloud Platform services
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View your data across Google Cloud Platform services
CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
// View and administer all your Firebase data and settings
FirebaseScope = "https://www.googleapis.com/auth/firebase"
// View all your Firebase data and settings
FirebaseReadonlyScope = "https://www.googleapis.com/auth/firebase.readonly"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Sites = NewSitesService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Sites *SitesService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewSitesService(s *Service) *SitesService {
rs := &SitesService{s: s}
rs.Domains = NewSitesDomainsService(s)
rs.Releases = NewSitesReleasesService(s)
rs.Versions = NewSitesVersionsService(s)
return rs
}
type SitesService struct {
s *Service
Domains *SitesDomainsService
Releases *SitesReleasesService
Versions *SitesVersionsService
}
func NewSitesDomainsService(s *Service) *SitesDomainsService {
rs := &SitesDomainsService{s: s}
return rs
}
type SitesDomainsService struct {
s *Service
}
func NewSitesReleasesService(s *Service) *SitesReleasesService {
rs := &SitesReleasesService{s: s}
return rs
}
type SitesReleasesService struct {
s *Service
}
func NewSitesVersionsService(s *Service) *SitesVersionsService {
rs := &SitesVersionsService{s: s}
rs.Files = NewSitesVersionsFilesService(s)
return rs
}
type SitesVersionsService struct {
s *Service
Files *SitesVersionsFilesService
}
func NewSitesVersionsFilesService(s *Service) *SitesVersionsFilesService {
rs := &SitesVersionsFilesService{s: s}
return rs
}
type SitesVersionsFilesService struct {
s *Service
}
// ActingUser: Contains metadata about the user who performed an action,
// such as creating
// a release or finalizing a version.
type ActingUser struct {
// Email: The email address of the user when the user performed the
// action.
Email string `json:"email,omitempty"`
// ImageUrl: 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 `json:"imageUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "Email") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Email") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ActingUser) MarshalJSON() ([]byte, error) {
type NoMethod ActingUser
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CertDnsChallenge: Represents a DNS certificate challenge.
type CertDnsChallenge struct {
// DomainName: The domain name upon which the DNS challenge must be
// satisfied.
DomainName string `json:"domainName,omitempty"`
// Token: The value that must be present as a TXT record on the domain
// name to
// satisfy the challenge.
Token string `json:"token,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CertDnsChallenge) MarshalJSON() ([]byte, error) {
type NoMethod CertDnsChallenge
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CertHttpChallenge: Represents an HTTP certificate challenge.
type CertHttpChallenge struct {
// Path: The URL path on which to serve the specified token to satisfy
// the
// certificate challenge.
Path string `json:"path,omitempty"`
// Token: The token to serve at the specified URL path to satisfy the
// certificate
// challenge.
Token string `json:"token,omitempty"`
// ForceSendFields is a list of field names (e.g. "Path") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Path") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CertHttpChallenge) MarshalJSON() ([]byte, error) {
type NoMethod CertHttpChallenge
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CloudRunRewrite: 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).
type CloudRunRewrite struct {
// Region: Optional. User-provided region where the Cloud Run service is
// hosted.<br>
// Defaults to `us-central1` if not supplied.
Region string `json:"region,omitempty"`
// ServiceId: Required. User-defined ID of the Cloud Run service.
ServiceId string `json:"serviceId,omitempty"`
// ForceSendFields is a list of field names (e.g. "Region") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Region") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CloudRunRewrite) MarshalJSON() ([]byte, error) {
type NoMethod CloudRunRewrite
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Domain: The intended behavior and status information of a domain.
type Domain struct {
// DomainName: Required. The domain name of the association.
DomainName string `json:"domainName,omitempty"`
// DomainRedirect: If set, the domain should redirect with the provided
// parameters.
DomainRedirect *DomainRedirect `json:"domainRedirect,omitempty"`
// Provisioning: Output only. Information about the provisioning of
// certificates and the
// health of the DNS resolution for the domain.
Provisioning *DomainProvisioning `json:"provisioning,omitempty"`
// Site: Required. The site name of the association.
Site string `json:"site,omitempty"`
// Status: Output only. Additional status of the domain association.
//
// Possible values:
// "DOMAIN_STATUS_UNSPECIFIED" - Unspecified domain association
// status.
// "DOMAIN_CHANGE_PENDING" - An operation is in progress on the domain
// association and no further
// operations can be performed until it is complete.
// "DOMAIN_ACTIVE" - The domain association is active and no
// additional action is required.
// "DOMAIN_VERIFICATION_REQUIRED" - The domain was previously verified
// in the legacy system. User must
// reverify the domain through the ownership service.
// "DOMAIN_VERIFICATION_LOST" - The domain verification has been lost
// and the domain is in the grace period
// before being removed from the Firebase Hosting site.
Status string `json:"status,omitempty"`
// UpdateTime: Output only. The time at which the domain was last
// updated.
UpdateTime string `json:"updateTime,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Domain) MarshalJSON() ([]byte, error) {
type NoMethod Domain
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DomainProvisioning: The current certificate provisioning status
// information for a domain.
type DomainProvisioning struct {
// CertChallengeDiscoveredTxt: The TXT records (for the certificate
// challenge) that were found at the last
// DNS fetch.
CertChallengeDiscoveredTxt []string `json:"certChallengeDiscoveredTxt,omitempty"`
// CertChallengeDns: The DNS challenge for generating a certificate.
CertChallengeDns *CertDnsChallenge `json:"certChallengeDns,omitempty"`
// CertChallengeHttp: The HTTP challenge for generating a certificate.
CertChallengeHttp *CertHttpChallenge `json:"certChallengeHttp,omitempty"`
// CertStatus: The certificate provisioning status; updated when
// Firebase Hosting
// provisions an SSL certificate for the domain.
//
// Possible values:
// "CERT_STATUS_UNSPECIFIED" - Unspecified certificate provisioning
// status.
// "CERT_PENDING" - Waiting for certificate challenge to be created.
// "CERT_MISSING" - Waiting for certificate challenge to be met.
// "CERT_PROCESSING" - Certificate challenge met; attempting to
// acquire/propagate certificate.
// "CERT_PROPAGATING" - Certificate obtained; propagating to the CDN.
// "CERT_ACTIVE" - Certificate provisioned and deployed across the
// CDN.
// "CERT_ERROR" - Certificate provisioning failed in a non-recoverable
// manner.
CertStatus string `json:"certStatus,omitempty"`
// DiscoveredIps: The IPs found at the last DNS fetch.
DiscoveredIps []string `json:"discoveredIps,omitempty"`
// DnsFetchTime: The time at which the last DNS fetch occurred.
DnsFetchTime string `json:"dnsFetchTime,omitempty"`
// DnsStatus: The DNS record match status as of the last DNS fetch.
//
// Possible values:
// "DNS_STATUS_UNSPECIFIED" - Unspecified DNS status.
// "DNS_PENDING" - No DNS records have been specified for this domain
// yet.
// "DNS_MISSING" - None of the required DNS records have been detected
// on the domain.
// "DNS_PARTIAL_MATCH" - Some of the required DNS records were
// detected, but not all of them. No
// extra (non-required) DNS records were detected.
// "DNS_MATCH" - All required DNS records were detected. No extra
// (non-required) DNS records
// were detected.
// "DNS_EXTRANEOUS_MATCH" - The domain has at least one of the
// required DNS records, and it has at
// least one extra (non-required) DNS record.
DnsStatus string `json:"dnsStatus,omitempty"`
// ExpectedIps: The list of IPs to which the domain is expected to
// resolve.
ExpectedIps []string `json:"expectedIps,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "CertChallengeDiscoveredTxt") to unconditionally include in API
// requests. By default, fields with empty values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "CertChallengeDiscoveredTxt") to include in API requests with the
// JSON null value. By default, fields with empty values are omitted
// from API requests. However, any field with an empty value appearing
// in NullFields will be sent to the server as null. It is an error if a
// field in this list has a non-empty value. This may be used to include
// null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DomainProvisioning) MarshalJSON() ([]byte, error) {
type NoMethod DomainProvisioning
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DomainRedirect: 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.
type DomainRedirect struct {
// DomainName: Required. The domain name to redirect to.
DomainName string `json:"domainName,omitempty"`
// Type: Required. The redirect status code.
//
// Possible values:
// "REDIRECT_TYPE_UNSPECIFIED" - The default redirect type; should not
// be intentionlly used.
// "MOVED_PERMANENTLY" - The redirect will respond with an HTTP status
// code of
// `301 Moved Permanently`.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "DomainName") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DomainName") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DomainRedirect) MarshalJSON() ([]byte, error) {
type NoMethod DomainRedirect
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Empty: 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 `{}`.
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// Header: A [`header`](/docs/hosting/full-config#headers) defines
// custom headers to
// add to a response should the request URL path match the pattern.
type Header struct {
// Glob: The user-supplied
// [glob
// pattern](/docs/hosting/full-config#glob_pattern_matching) to
// match
// against the request URL path.
Glob string `json:"glob,omitempty"`
// Headers: Required. The additional headers to add to the response.
Headers map[string]string `json:"headers,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the
// request
// URL path.
Regex string `json:"regex,omitempty"`
// ForceSendFields is a list of field names (e.g. "Glob") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Glob") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Header) MarshalJSON() ([]byte, error) {
type NoMethod Header
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListDomainsResponse struct {
// Domains: The list of domains, if any exist.
Domains []*Domain `json:"domains,omitempty"`
// NextPageToken: The pagination token, if more results exist.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Domains") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Domains") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListDomainsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListDomainsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListReleasesResponse struct {
// NextPageToken: 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 `json:"nextPageToken,omitempty"`
// Releases: The list of hashes of files that still need to be uploaded,
// if any exist.
Releases []*Release `json:"releases,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListReleasesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListReleasesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListVersionFilesResponse struct {
// Files: The list path/hashes in the specified version.
Files []*VersionFile `json:"files,omitempty"`
// NextPageToken: The pagination token, if more results exist.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Files") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Files") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListVersionFilesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListVersionFilesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type PopulateVersionFilesRequest struct {
// Files: 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 map[string]string `json:"files,omitempty"`
// ForceSendFields is a list of field names (e.g. "Files") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Files") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *PopulateVersionFilesRequest) MarshalJSON() ([]byte, error) {
type NoMethod PopulateVersionFilesRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type PopulateVersionFilesResponse struct {
// UploadRequiredHashes: The content hashes of the specified files that
// need to be uploaded to the
// specified endpoint.
UploadRequiredHashes []string `json:"uploadRequiredHashes,omitempty"`
// UploadUrl: The URL to which the files should be uploaded, in the
// format:
// <br>"https://upload-firebasehosting.googleapis.com/upload/site
// s/<var>site-name</var>/versions/<var>versionID</var>/files".
// <br>Perfo
// rm 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 `json:"uploadUrl,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "UploadRequiredHashes") to unconditionally include in API requests.
// By default, fields with empty values are omitted from API requests.
// However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "UploadRequiredHashes") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *PopulateVersionFilesResponse) MarshalJSON() ([]byte, error) {
type NoMethod PopulateVersionFilesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Redirect: A [`redirect`](/docs/hosting/full-config#redirects)
// represents the
// configuration for returning an HTTP redirect response given a
// matching
// request URL path.
type Redirect struct {
// Glob: The user-supplied
// [glob
// pattern](/docs/hosting/full-config#glob_pattern_matching) to
// match
// against the request URL path.
Glob string `json:"glob,omitempty"`
// Location: 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 `json:"location,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the
// request
// URL path.
Regex string `json:"regex,omitempty"`
// StatusCode: Required. The status HTTP code to return in the response.
// It must be a
// valid 3xx status code.
StatusCode int64 `json:"statusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Glob") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Glob") to include in API
// requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Redirect) MarshalJSON() ([]byte, error) {
type NoMethod Redirect
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Release: A `Release` is a particular
// [collection of configurations and files](sites.versions)
// that is set to be public at a particular time.
type Release struct {
// Message: The deploy description when the release was created. The
// value can be up to
// 512 characters.
Message string `json:"message,omitempty"`
// Name: 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 `json:"name,omitempty"`
// ReleaseTime: Output only. The time at which the version is set to be
// public.
ReleaseTime string `json:"releaseTime,omitempty"`
// ReleaseUser: Output only. Identifies the user who created the
// release.
ReleaseUser *ActingUser `json:"releaseUser,omitempty"`
// Type: Explains the reason for the release.
// <br>Specify a value for this field only when creating a
// `SITE_DISABLE`
// type release.
//
// Possible values:
// "TYPE_UNSPECIFIED" - An unspecified type. Indicates that a version
// was released.
// <br>This is the default value when no other `type` is
// explicitly
// specified.
// "DEPLOY" - A version was uploaded to Firebase Hosting and released.
// "ROLLBACK" - The release points back to a previously deployed
// version.
// "SITE_DISABLE" - The release prevents the site from serving
// content. Firebase Hosting acts
// as if the site never existed.
Type string `json:"type,omitempty"`
// Version: Output only. The configuration and content that was
// released.
Version *Version `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Message") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Message") to include in
// API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Release) MarshalJSON() ([]byte, error) {
type NoMethod Release
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Rewrite: 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.
type Rewrite struct {
// DynamicLinks: The request will be forwarded to Firebase Dynamic
// Links.
DynamicLinks bool `json:"dynamicLinks,omitempty"`
// Function: The function to proxy requests to. Must match the exported
// function
// name exactly.
Function string `json:"function,omitempty"`
// Glob: The user-supplied
// [glob
// pattern](/docs/hosting/full-config#glob_pattern_matching) to
// match
// against the request URL path.
Glob string `json:"glob,omitempty"`
// Path: The URL path to rewrite the request to.
Path string `json:"path,omitempty"`
// Regex: The user-supplied RE2 regular expression to match against the
// request
// URL path.
Regex string `json:"regex,omitempty"`
// Run: The request will be forwarded to Cloud Run.
Run *CloudRunRewrite `json:"run,omitempty"`
// ForceSendFields is a list of field names (e.g. "DynamicLinks") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DynamicLinks") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Rewrite) MarshalJSON() ([]byte, error) {
type NoMethod Rewrite
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ServingConfig: 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).
type ServingConfig struct {
// AppAssociation: How to handle well known App Association files.
//
// Possible values:
// "AUTO" - The app association files will be automattically created
// from the apps
// that exist in the Firebase project.
// "NONE" - No special handling of the app association files will
// occur, these paths
// will result in a 404 unless caught with a Rewrite.