-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
firebasehosting-gen.go
1598 lines (1451 loc) · 61.1 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 2024 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/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/firebasehosting/v1"
// ...
// 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 [google.golang.org/api/option.WithScopes]:
//
// firebasehostingService, err := firebasehosting.NewService(ctx, option.WithScopes(firebasehosting.FirebaseScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/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 [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// firebasehostingService, err := firebasehosting.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package firebasehosting // import "google.golang.org/api/firebasehosting/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
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
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "firebasehosting:v1"
const apiName = "firebasehosting"
const apiVersion = "v1"
const basePath = "https://firebasehosting.googleapis.com/"
const basePathTemplate = "https://firebasehosting.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://firebasehosting.mtls.googleapis.com/"
const defaultUniverseDomain = "googleapis.com"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the
// email address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View and administer all your Firebase data and settings
FirebaseScope = "https://www.googleapis.com/auth/firebase"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.WithDefaultUniverseDomain(defaultUniverseDomain))
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.Operations = NewOperationsService(s)
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Operations *OperationsService
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewOperationsService(s *Service) *OperationsService {
rs := &OperationsService{s: s}
return rs
}
type OperationsService struct {
s *Service
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Sites = NewProjectsSitesService(s)
return rs
}
type ProjectsService struct {
s *Service
Sites *ProjectsSitesService
}
func NewProjectsSitesService(s *Service) *ProjectsSitesService {
rs := &ProjectsSitesService{s: s}
rs.CustomDomains = NewProjectsSitesCustomDomainsService(s)
return rs
}
type ProjectsSitesService struct {
s *Service
CustomDomains *ProjectsSitesCustomDomainsService
}
func NewProjectsSitesCustomDomainsService(s *Service) *ProjectsSitesCustomDomainsService {
rs := &ProjectsSitesCustomDomainsService{s: s}
rs.Operations = NewProjectsSitesCustomDomainsOperationsService(s)
return rs
}
type ProjectsSitesCustomDomainsService struct {
s *Service
Operations *ProjectsSitesCustomDomainsOperationsService
}
func NewProjectsSitesCustomDomainsOperationsService(s *Service) *ProjectsSitesCustomDomainsOperationsService {
rs := &ProjectsSitesCustomDomainsOperationsService{s: s}
return rs
}
type ProjectsSitesCustomDomainsOperationsService struct {
s *Service
}
// CancelOperationRequest: The request message for
// Operations.CancelOperation.
type CancelOperationRequest struct {
}
// CertVerification: A set of ACME challenges you can use to allow
// Hosting to create an SSL certificate for your domain name before
// directing traffic to Hosting servers. Use either the DNS or HTTP
// challenge; it's not necessary to provide both.
type CertVerification struct {
// Dns: Output only. A `TXT` record to add to your DNS records that
// confirms your intent to let Hosting create an SSL cert for your
// domain name.
Dns *DnsUpdates `json:"dns,omitempty"`
// Http: Output only. A file to add to your existing, non-Hosting
// hosting service that confirms your intent to let Hosting create an
// SSL cert for your domain name.
Http *HttpUpdate `json:"http,omitempty"`
// ForceSendFields is a list of field names (e.g. "Dns") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Dns") 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 *CertVerification) MarshalJSON() ([]byte, error) {
type NoMethod CertVerification
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CustomDomainMetadata: Metadata associated with a`CustomDomain`
// operation.
type CustomDomainMetadata struct {
// CertState: The `CertState` of the domain name's SSL certificate.
//
// Possible values:
// "CERT_STATE_UNSPECIFIED" - The certificate's state is unspecified.
// The message is invalid if this is unspecified.
// "CERT_PREPARING" - The initial state of every certificate,
// represents Hosting's intent to create a certificate, before requests
// to a Certificate Authority are made.
// "CERT_VALIDATING" - Hosting is validating whether a domain name's
// DNS records are in a state that allow certificate creation on its
// behalf.
// "CERT_PROPAGATING" - The certificate was recently created, and
// needs time to propagate in Hosting's CDN.
// "CERT_ACTIVE" - The certificate is active, providing secure
// connections for the domain names it represents.
// "CERT_EXPIRING_SOON" - The certificate is expiring, all domain
// names on it will be given new certificates.
// "CERT_EXPIRED" - The certificate has expired. Hosting can no longer
// serve secure content on your domain name.
CertState string `json:"certState,omitempty"`
// HostState: The `HostState` of the domain name this `CustomDomain`
// refers to.
//
// Possible values:
// "HOST_STATE_UNSPECIFIED" - Your custom domain's host state is
// unspecified. The message is invalid if this is unspecified.
// "HOST_UNHOSTED" - Your custom domain's domain name isn't associated
// with any IP addresses.
// "HOST_UNREACHABLE" - Your custom domain's domain name can't be
// reached. Hosting services' DNS queries to find your domain name's IP
// addresses resulted in errors. See your `CustomDomain` object's
// `issues` field for more details.
// "HOST_MISMATCH" - Your custom domain's domain name has IP addresses
// that don't ultimately resolve to Hosting.
// "HOST_CONFLICT" - Your custom domain's domain name has IP addresses
// that resolve to both Hosting and other services. To ensure consistent
// results, remove `A` and `AAAA` records related to non-Hosting
// services.
// "HOST_ACTIVE" - All requests against your custom domain's domain
// name are served by Hosting. If the custom domain's `OwnershipState`
// is also `ACTIVE`, Hosting serves your Hosting site's content on the
// domain name.
HostState string `json:"hostState,omitempty"`
// Issues: A list of issues that are currently preventing Hosting from
// completing the operation. These are generally DNS-related issues that
// Hosting encounters when querying a domain name's records or
// attempting to mint an SSL certificate.
Issues []*Status `json:"issues,omitempty"`
// LiveMigrationSteps: A set of DNS record updates and ACME challenges
// that allow you to transition domain names to Firebase Hosting with
// zero downtime. These updates allow Hosting to create an SSL
// certificate and establish ownership for your custom domain before
// Hosting begins serving traffic on it. If your domain name is already
// in active use with another provider, add one of the challenges and
// make the recommended DNS updates. After adding challenges and
// adjusting DNS records as necessary, wait for the `ownershipState` to
// be `OWNERSHIP_ACTIVE` and the `certState` to be `CERT_ACTIVE` before
// sending traffic to Hosting.
LiveMigrationSteps []*LiveMigrationStep `json:"liveMigrationSteps,omitempty"`
// OwnershipState: The `OwnershipState` of the domain name this
// `CustomDomain` refers to.
//
// Possible values:
// "OWNERSHIP_STATE_UNSPECIFIED" - Your custom domain's ownership
// state is unspecified. This should never happen.
// "OWNERSHIP_MISSING" - Your custom domain's domain name has no
// Hosting-related ownership records; no Firebase project has permission
// to act on the domain name's behalf.
// "OWNERSHIP_UNREACHABLE" - Your custom domain's domain name can't be
// reached. Hosting services' DNS queries to find your domain name's
// ownership records resulted in errors. See your `CustomDomain`
// object's `issues` field for more details.
// "OWNERSHIP_MISMATCH" - Your custom domain's domain name is owned by
// another Firebase project. Remove the conflicting `TXT` records and
// replace them with project-specific records for your current Firebase
// project.
// "OWNERSHIP_CONFLICT" - Your custom domain's domain name has
// conflicting `TXT` records that indicate ownership by both your
// current Firebase project and another project. Remove the other
// project's ownership records to grant the current project ownership.
// "OWNERSHIP_PENDING" - Your custom domain's DNS records are
// configured correctly. Hosting will transfer ownership of your domain
// to this `CustomDomain` within 24 hours.
// "OWNERSHIP_ACTIVE" - Your custom domain's domain name has `TXT`
// records that grant its project permission to act on its behalf.
OwnershipState string `json:"ownershipState,omitempty"`
// QuickSetupUpdates: A set of DNS record updates that allow Hosting to
// serve secure content on your domain name. The record type determines
// the update's purpose: - `A` and `AAAA`: Updates your domain name's IP
// addresses so that they direct traffic to Hosting servers. - `TXT`:
// Updates ownership permissions on your domain name, letting Hosting
// know that your custom domain's project has permission to perfrom
// actions for that domain name. - `CAA`: Updates your domain name's
// list of authorized Certificate Authorities (CAs). Only present if you
// have existing `CAA` records that prohibit Hosting's CA from minting
// certs for your domain name. These updates include all DNS changes
// you'll need to get started with Hosting, but, if made all at once,
// can result in a brief period of downtime for your domain name--while
// Hosting creates and uploads an SSL cert, for example. If you'd like
// to add your domain name to Hosting without downtime, complete the
// `liveMigrationSteps` first, before making the remaining updates in
// this field.
QuickSetupUpdates *DnsUpdates `json:"quickSetupUpdates,omitempty"`
// ForceSendFields is a list of field names (e.g. "CertState") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CertState") 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 *CustomDomainMetadata) MarshalJSON() ([]byte, error) {
type NoMethod CustomDomainMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DnsRecord: DNS records are resource records that define how systems
// and services should behave when handling requests for a domain name.
// For example, when you add `A` records to your domain name's DNS
// records, you're informing other systems (such as your users' web
// browsers) to contact those IPv4 addresses to retrieve resources
// relevant to your domain name (such as your Hosting site files).
type DnsRecord struct {
// DomainName: Output only. The domain name the record pertains to, e.g.
// `foo.bar.com.`.
DomainName string `json:"domainName,omitempty"`
// Rdata: Output only. The data of the record. The meaning of the value
// depends on record type: - A and AAAA: IP addresses for the domain
// name. - CNAME: Another domain to check for records. - TXT: Arbitrary
// text strings associated with the domain name. Hosting uses TXT
// records to determine which Firebase projects have permission to act
// on the domain name's behalf. - CAA: The record's flags, tag, and
// value, e.g. `0 issue "pki.goog".
Rdata string `json:"rdata,omitempty"`
// RequiredAction: Output only. An enum that indicates the a required
// action for this record.
//
// Possible values:
// "NONE" - No action necessary.
// "ADD" - Add this record to your DNS records.
// "REMOVE" - Remove this record from your DNS records.
RequiredAction string `json:"requiredAction,omitempty"`
// Type: Output only. The record's type, which determines what data the
// record contains.
//
// Possible values:
// "TYPE_UNSPECIFIED" - The record's type is unspecified. The message
// is invalid if this is unspecified.
// "A" - An `A` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). A records determine which
// IPv4 addresses a domain name directs traffic towards.
// "CNAME" - A `CNAME` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). `CNAME` or Canonical Name
// records map a domain name to a different, canonical domain name. If a
// `CNAME` record is present, it should be the only record on the domain
// name.
// "TXT" - A `TXT` record, as defined in [RFC
// 1035](https://tools.ietf.org/html/rfc1035). `TXT` records hold
// arbitrary text data on a domain name. Hosting uses `TXT` records to
// establish which Firebase Project has permission to act on a domain
// name.
// "AAAA" - An AAAA record, as defined in [RFC
// 3596](https://tools.ietf.org/html/rfc3596) AAAA records determine
// which IPv6 addresses a domain name directs traffic towards.
// "CAA" - A CAA record, as defined in [RFC
// 6844](https://tools.ietf.org/html/rfc6844). CAA, or Certificate
// Authority Authorization, records determine which Certificate
// Authorities (SSL certificate minting organizations) are authorized to
// mint a certificate for the domain name. Firebase Hosting uses
// `pki.goog` as its primary CA. CAA records cascade. A CAA record on
// `foo.com` also applies to `bar.foo.com` unless `bar.foo.com` has its
// own set of CAA records. CAA records are optional. If a domain name
// and its parents have no CAA records, all CAs are authorized to mint
// certificates on its behalf. In general, Hosting only asks you to
// modify CAA records when doing so is required to unblock SSL cert
// creation.
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 or default 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 *DnsRecord) MarshalJSON() ([]byte, error) {
type NoMethod DnsRecord
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DnsRecordSet: A set of DNS records relevant to the setup and
// maintenance of a custom domain in Firebase Hosting.
type DnsRecordSet struct {
// CheckError: Output only. An error Hosting services encountered when
// querying your domain name's DNS records. Note: Hosting ignores
// `NXDOMAIN` errors, as those generally just mean that a domain name
// hasn't been set up yet.
CheckError *Status `json:"checkError,omitempty"`
// DomainName: Output only. The domain name the record set pertains to.
DomainName string `json:"domainName,omitempty"`
// Records: Output only. Records on the domain.
Records []*DnsRecord `json:"records,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckError") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CheckError") 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 *DnsRecordSet) MarshalJSON() ([]byte, error) {
type NoMethod DnsRecordSet
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DnsUpdates: A set of DNS record updates that you should make to allow
// Hosting to serve secure content in response to requests against your
// domain name. These updates present the current state of your domain
// name's DNS records when Hosting last queried them, and the desired
// set of records that Hosting needs to see before your custom domain
// can be fully active.
type DnsUpdates struct {
// CheckTime: The last time Hosting checked your custom domain's DNS
// records.
CheckTime string `json:"checkTime,omitempty"`
// Desired: The set of DNS records Hosting needs to serve secure content
// on the domain.
Desired []*DnsRecordSet `json:"desired,omitempty"`
// Discovered: The set of DNS records Hosting discovered when inspecting
// a domain.
Discovered []*DnsRecordSet `json:"discovered,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckTime") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CheckTime") 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 *DnsUpdates) MarshalJSON() ([]byte, error) {
type NoMethod DnsUpdates
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); }
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
}
// HttpUpdate: A file you can add to your existing, non-Hosting hosting
// service that confirms your intent to allow Hosting's Certificate
// Authorities to create an SSL certificate for your domain.
type HttpUpdate struct {
// CheckError: Output only. An error encountered during the last
// contents check. If null, the check completed successfully.
CheckError *Status `json:"checkError,omitempty"`
// Desired: Output only. A text string to serve at the path.
Desired string `json:"desired,omitempty"`
// Discovered: Output only. Whether Hosting was able to find the
// required file contents on the specified path during its last check.
Discovered string `json:"discovered,omitempty"`
// LastCheckTime: Output only. The last time Hosting systems checked for
// the file contents.
LastCheckTime string `json:"lastCheckTime,omitempty"`
// Path: Output only. The path to the file.
Path string `json:"path,omitempty"`
// ForceSendFields is a list of field names (e.g. "CheckError") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CheckError") 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 *HttpUpdate) MarshalJSON() ([]byte, error) {
type NoMethod HttpUpdate
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListOperationsResponse: The response message for
// Operations.ListOperations.
type ListOperationsResponse struct {
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: A list of operations that matches the specified filter in
// the request.
Operations []*Operation `json:"operations,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 or default 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 *ListOperationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListOperationsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// LiveMigrationStep: A set of updates including ACME challenges and DNS
// records that allow Hosting to create an SSL certificate and establish
// project ownership for your domain name before you direct traffic to
// Hosting servers. Use these updates to facilitate zero downtime
// migrations to Hosting from other services. After you've made the
// recommended updates, check your custom domain's `ownershipState` and
// `certState`. To avoid downtime, they should be `OWNERSHIP_ACTIVE` and
// `CERT_ACTIVE`, respectively, before you update your `A` and `AAAA`
// records.
type LiveMigrationStep struct {
// CertVerification: Output only. A pair of ACME challenges that
// Hosting's Certificate Authority (CA) can use to create an SSL cert
// for your domain name. Use either the DNS or HTTP challenge; it's not
// necessary to provide both.
CertVerification *CertVerification `json:"certVerification,omitempty"`
// DnsUpdates: Output only. DNS updates to facilitate your domain's
// zero-downtime migration to Hosting.
DnsUpdates *DnsUpdates `json:"dnsUpdates,omitempty"`
// Issues: Output only. Issues that prevent the current step from
// completing.
Issues []*Status `json:"issues,omitempty"`
// State: Output only. The state of the live migration step, indicates
// whether you should work to complete the step now, in the future, or
// have already completed it.
//
// Possible values:
// "STATE_UNSPECIFIED" - The step's state is unspecified. The message
// is invalid if this is unspecified.
// "PREPARING" - Hosting doesn't have enough information to construct
// the step yet. Complete any prior steps and/or resolve this step's
// issue to proceed.
// "PENDING" - The step's state is pending. Complete prior steps
// before working on a `PENDING` step.
// "INCOMPLETE" - The step is incomplete. You should complete any
// `certVerification` or `dnsUpdates` changes to complete it.
// "PROCESSING" - You've done your part to update records and present
// challenges as necessary. Hosting is now completing background
// processes to complete the step, e.g. minting an SSL cert for your
// domain name.
// "COMPLETE" - The step is complete. You've already made the
// necessary changes to your domain and/or prior hosting service to
// advance to the next step. Once all steps are complete, Hosting is
// ready to serve secure content on your domain.
State string `json:"state,omitempty"`
// ForceSendFields is a list of field names (e.g. "CertVerification") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "CertVerification") 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 *LiveMigrationStep) MarshalJSON() ([]byte, error) {
type NoMethod LiveMigrationStep
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Operation: This resource represents a long-running operation that is
// the result of a network API call.
type Operation struct {
// Done: 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 bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure or
// cancellation.
Error *Status `json:"error,omitempty"`
// Metadata: Service-specific metadata associated with the operation. It
// typically contains progress information and common metadata such as
// create time. Some services might not provide such metadata. Any
// method that returns a long-running operation should document the
// metadata type, if any.
Metadata googleapi.RawMessage `json:"metadata,omitempty"`
// Name: The server-assigned name, which is only unique within the same
// service that originally returns it. If you use the default HTTP
// mapping, the `name` should be a resource name ending with
// `operations/{unique_id}`.
Name string `json:"name,omitempty"`
// Response: The normal, successful response of the operation. If the
// original method returns no data on success, such as `Delete`, the
// response is `google.protobuf.Empty`. If the original method is
// standard `Get`/`Create`/`Update`, the response should be the
// resource. For other methods, the response should have the type
// `XxxResponse`, where `Xxx` is the original method name. For example,
// if the original method name is `TakeSnapshot()`, the inferred
// response type is `TakeSnapshotResponse`.
Response googleapi.RawMessage `json:"response,omitempty"`
// ForceSendFields is a list of field names (e.g. "Done") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Done") 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 *Operation) MarshalJSON() ([]byte, error) {
type NoMethod Operation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Status: The `Status` type defines a logical error model that is
// suitable for different programming environments, including REST APIs
// and RPC APIs. It is used by gRPC (https://github.com/grpc). Each
// `Status` message contains three pieces of data: error code, error
// message, and error details. You can find out more about this error
// model and how to work with it in the API Design Guide
// (https://cloud.google.com/apis/design/errors).
type Status struct {
// Code: The status code, which should be an enum value of
// google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a
// common set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: 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 `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to
// unconditionally include in API requests. By default, fields with
// empty or default 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. "Code") 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 *Status) MarshalJSON() ([]byte, error) {
type NoMethod Status
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// method id "firebasehosting.operations.cancel":
type OperationsCancelCall struct {
s *Service
name string
canceloperationrequest *CancelOperationRequest
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// Cancel: Starts asynchronous cancellation on a long-running operation.
// The server makes a best effort to cancel the operation, but success
// is not guaranteed. If the server doesn't support this method, it
// returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use
// Operations.GetOperation or other methods to check whether the
// cancellation succeeded or whether the operation completed despite
// cancellation. On successful cancellation, the operation is not
// deleted; instead, it becomes an operation with an Operation.error
// value with a google.rpc.Status.code of 1, corresponding to
// `Code.CANCELLED`.
//
// - name: The name of the operation resource to be cancelled.
func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall {
c := &OperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
c.canceloperationrequest = canceloperationrequest
return c
}
// Fields allows partial responses to be retrieved. See
// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse
// for more information.
func (c *OperationsCancelCall) Fields(s ...googleapi.Field) *OperationsCancelCall {
c.urlParams_.Set("fields", googleapi.CombineFields(s))
return c
}
// Context sets the context to be used in this call's Do method. Any
// pending HTTP request will be aborted if the provided context is
// canceled.
func (c *OperationsCancelCall) Context(ctx context.Context) *OperationsCancelCall {
c.ctx_ = ctx
return c
}
// Header returns an http.Header that can be modified by the caller to
// add HTTP headers to the request.
func (c *OperationsCancelCall) Header() http.Header {
if c.header_ == nil {
c.header_ = make(http.Header)
}
return c.header_
}
func (c *OperationsCancelCall) doRequest(alt string) (*http.Response, error) {
reqHeaders := make(http.Header)
reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version)
for k, v := range c.header_ {
reqHeaders[k] = v
}
reqHeaders.Set("User-Agent", c.s.userAgent())
var body io.Reader = nil
body, err := googleapi.WithoutDataWrapper.JSONReader(c.canceloperationrequest)
if err != nil {
return nil, err
}
reqHeaders.Set("Content-Type", "application/json")
c.urlParams_.Set("alt", alt)
c.urlParams_.Set("prettyPrint", "false")
urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel")
urls += "?" + c.urlParams_.Encode()
req, err := http.NewRequest("POST", urls, body)
if err != nil {
return nil, err
}
req.Header = reqHeaders
googleapi.Expand(req.URL, map[string]string{
"name": c.name,
})
return gensupport.SendRequest(c.ctx_, c.s.client, req)
}
// Do executes the "firebasehosting.operations.cancel" call.
// Exactly one of *Empty or error will be non-nil. Any non-2xx status
// code is an error. Response headers are in either
// *Empty.ServerResponse.Header or (if a response was returned at all)
// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to
// check whether the returned error was because http.StatusNotModified
// was returned.
func (c *OperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error) {
gensupport.SetOptions(c.urlParams_, opts...)
res, err := c.doRequest("json")
if res != nil && res.StatusCode == http.StatusNotModified {
if res.Body != nil {
res.Body.Close()
}
return nil, gensupport.WrapError(&googleapi.Error{
Code: res.StatusCode,
Header: res.Header,
})
}
if err != nil {
return nil, err
}
defer googleapi.CloseBody(res)
if err := googleapi.CheckResponse(res); err != nil {
return nil, gensupport.WrapError(err)
}
ret := &Empty{
ServerResponse: googleapi.ServerResponse{
Header: res.Header,
HTTPStatusCode: res.StatusCode,
},
}
target := &ret
if err := gensupport.DecodeResponse(target, res); err != nil {
return nil, err
}
return ret, nil
// {
// "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
// "flatPath": "v1/operations/{operationsId}:cancel",
// "httpMethod": "POST",
// "id": "firebasehosting.operations.cancel",
// "parameterOrder": [
// "name"
// ],
// "parameters": {
// "name": {
// "description": "The name of the operation resource to be cancelled.",
// "location": "path",
// "pattern": "^operations/.*$",
// "required": true,
// "type": "string"
// }
// },
// "path": "v1/{+name}:cancel",
// "request": {
// "$ref": "CancelOperationRequest"
// },
// "response": {
// "$ref": "Empty"
// }
// }
}
// method id "firebasehosting.operations.delete":
type OperationsDeleteCall struct {
s *Service
name string
urlParams_ gensupport.URLParams
ctx_ context.Context
header_ http.Header
}
// Delete: Deletes a long-running operation. This method indicates that
// the client is no longer interested in the operation result. It does
// not cancel the operation. If the server doesn't support this method,
// it returns `google.rpc.Code.UNIMPLEMENTED`.
//
// - name: The name of the operation resource to be deleted.