-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
firebase-gen.go
7058 lines (6477 loc) · 277 KB
/
firebase-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 2022 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 firebase provides access to the Firebase Management API.
//
// For product documentation, see: https://firebase.google.com
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/firebase/v1beta1"
// ...
// ctx := context.Background()
// firebaseService, err := firebase.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:
//
// firebaseService, err := firebase.NewService(ctx, option.WithScopes(firebase.FirebaseReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// firebaseService, err := firebase.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, ...)
// firebaseService, err := firebase.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package firebase // import "google.golang.org/api/firebase/v1beta1"
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
const apiId = "firebase:v1beta1"
const apiName = "firebase"
const apiVersion = "v1beta1"
const basePath = "https://firebase.googleapis.com/"
const mtlsBasePath = "https://firebase.mtls.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 your data across Google Cloud services and see the email address
// of your Google Account
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 := internaloption.WithDefaultScopes(
"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...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
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.AvailableProjects = NewAvailableProjectsService(s)
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
AvailableProjects *AvailableProjectsService
Operations *OperationsService
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewAvailableProjectsService(s *Service) *AvailableProjectsService {
rs := &AvailableProjectsService{s: s}
return rs
}
type AvailableProjectsService struct {
s *Service
}
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.AndroidApps = NewProjectsAndroidAppsService(s)
rs.AvailableLocations = NewProjectsAvailableLocationsService(s)
rs.DefaultLocation = NewProjectsDefaultLocationService(s)
rs.IosApps = NewProjectsIosAppsService(s)
rs.WebApps = NewProjectsWebAppsService(s)
return rs
}
type ProjectsService struct {
s *Service
AndroidApps *ProjectsAndroidAppsService
AvailableLocations *ProjectsAvailableLocationsService
DefaultLocation *ProjectsDefaultLocationService
IosApps *ProjectsIosAppsService
WebApps *ProjectsWebAppsService
}
func NewProjectsAndroidAppsService(s *Service) *ProjectsAndroidAppsService {
rs := &ProjectsAndroidAppsService{s: s}
rs.Sha = NewProjectsAndroidAppsShaService(s)
return rs
}
type ProjectsAndroidAppsService struct {
s *Service
Sha *ProjectsAndroidAppsShaService
}
func NewProjectsAndroidAppsShaService(s *Service) *ProjectsAndroidAppsShaService {
rs := &ProjectsAndroidAppsShaService{s: s}
return rs
}
type ProjectsAndroidAppsShaService struct {
s *Service
}
func NewProjectsAvailableLocationsService(s *Service) *ProjectsAvailableLocationsService {
rs := &ProjectsAvailableLocationsService{s: s}
return rs
}
type ProjectsAvailableLocationsService struct {
s *Service
}
func NewProjectsDefaultLocationService(s *Service) *ProjectsDefaultLocationService {
rs := &ProjectsDefaultLocationService{s: s}
return rs
}
type ProjectsDefaultLocationService struct {
s *Service
}
func NewProjectsIosAppsService(s *Service) *ProjectsIosAppsService {
rs := &ProjectsIosAppsService{s: s}
return rs
}
type ProjectsIosAppsService struct {
s *Service
}
func NewProjectsWebAppsService(s *Service) *ProjectsWebAppsService {
rs := &ProjectsWebAppsService{s: s}
return rs
}
type ProjectsWebAppsService struct {
s *Service
}
// AddFirebaseRequest: All fields are required.
type AddFirebaseRequest struct {
// LocationId: Deprecated. Instead, to set a Project's default GCP
// resource location, call `FinalizeDefaultLocation`
// (../projects.defaultLocation/finalize) after you add Firebase
// resources to the GCP `Project`. The ID of the Project's default GCP
// resource location. The location must be one of the available GCP
// resource locations
// (https://firebase.google.com/docs/projects/locations).
LocationId string `json:"locationId,omitempty"`
// ForceSendFields is a list of field names (e.g. "LocationId") 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. "LocationId") 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 *AddFirebaseRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddFirebaseRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type AddGoogleAnalyticsRequest struct {
// AnalyticsAccountId: The ID for the existing Google Analytics account
// (http://www.google.com/analytics/) that you want to link with the
// `FirebaseProject`. Specifying this field will provision a new Google
// Analytics property in your Google Analytics account and associate the
// new property with the `FirebaseProject`.
AnalyticsAccountId string `json:"analyticsAccountId,omitempty"`
// AnalyticsPropertyId: The ID for the existing Google Analytics
// property that you want to associate with the `FirebaseProject`.
AnalyticsPropertyId string `json:"analyticsPropertyId,omitempty"`
// ForceSendFields is a list of field names (e.g. "AnalyticsAccountId")
// 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. "AnalyticsAccountId") 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 *AddGoogleAnalyticsRequest) MarshalJSON() ([]byte, error) {
type NoMethod AddGoogleAnalyticsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type AdminSdkConfig struct {
// DatabaseURL: The default Firebase Realtime Database URL.
DatabaseURL string `json:"databaseURL,omitempty"`
// LocationId: The ID of the Project's default GCP resource location.
// The location is one of the available GCP resource locations
// (https://firebase.google.com/docs/projects/locations). This field is
// omitted if the default GCP resource location has not been finalized
// yet. To set a Project's default GCP resource location, call
// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
// after you add Firebase resources to the Project.
LocationId string `json:"locationId,omitempty"`
// ProjectId: Immutable. A user-assigned unique identifier for the
// `FirebaseProject`. This identifier may appear in URLs or names for
// some Firebase resources associated with the Project, but it should
// generally be treated as a convenience alias to reference the Project.
ProjectId string `json:"projectId,omitempty"`
// StorageBucket: The default Cloud Storage for Firebase storage bucket
// name.
StorageBucket string `json:"storageBucket,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DatabaseURL") 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. "DatabaseURL") 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 *AdminSdkConfig) MarshalJSON() ([]byte, error) {
type NoMethod AdminSdkConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type AnalyticsDetails struct {
// AnalyticsProperty: The Analytics Property object associated with the
// specified `FirebaseProject`. This object contains the details of the
// Google Analytics property associated with the Project.
AnalyticsProperty *AnalyticsProperty `json:"analyticsProperty,omitempty"`
// StreamMappings: - For `AndroidApps` and `IosApps`: a map of `app` to
// `streamId` for each Firebase App in the specified `FirebaseProject`.
// Each `app` and `streamId` appears only once. - For `WebApps`: a map
// of `app` to `streamId` and `measurementId` for each `WebApp` in the
// specified `FirebaseProject`. Each `app`, `streamId`, and
// `measurementId` appears only once.
StreamMappings []*StreamMapping `json:"streamMappings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AnalyticsProperty")
// 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. "AnalyticsProperty") 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 *AnalyticsDetails) MarshalJSON() ([]byte, error) {
type NoMethod AnalyticsDetails
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AnalyticsProperty: Details of a Google Analytics property
type AnalyticsProperty struct {
// AnalyticsAccountId: Output only. The ID of the Google Analytics
// account (https://www.google.com/analytics/) for the Google Analytics
// property associated with the specified FirebaseProject.
AnalyticsAccountId string `json:"analyticsAccountId,omitempty"`
// DisplayName: The display name of the Google Analytics property
// associated with the specified `FirebaseProject`.
DisplayName string `json:"displayName,omitempty"`
// Id: The globally unique, Google-assigned identifier of the Google
// Analytics property associated with the specified `FirebaseProject`.
// If you called `AddGoogleAnalytics`
// (../../v1beta1/projects/addGoogleAnalytics) to link the
// `FirebaseProject` with a Google Analytics account, the value in this
// `id` field is the same as the ID of the property either specified or
// provisioned with that call to `AddGoogleAnalytics`.
Id string `json:"id,omitempty"`
// ForceSendFields is a list of field names (e.g. "AnalyticsAccountId")
// 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. "AnalyticsAccountId") 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 *AnalyticsProperty) MarshalJSON() ([]byte, error) {
type NoMethod AnalyticsProperty
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AndroidApp: Details of a Firebase App for Android.
type AndroidApp struct {
// ApiKeyId: The key_id of the GCP ApiKey associated with this App. If
// set must have no restrictions, or only have restrictions that are
// valid for the associated Firebase App. Cannot be set in create
// requests, instead an existing valid API Key will be chosen, or if no
// valid API Keys exist, one will be provisioned for you. Cannot be set
// to an empty value in update requests.
ApiKeyId string `json:"apiKeyId,omitempty"`
// AppId: Immutable. The globally unique, Firebase-assigned identifier
// for the `AndroidApp`. This identifier should be treated as an opaque
// token, as the data format is not specified.
AppId string `json:"appId,omitempty"`
// DisplayName: The user-assigned display name for the `AndroidApp`.
DisplayName string `json:"displayName,omitempty"`
// Name: The resource name of the AndroidApp, in the format: projects/
// PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the
// parent Project's `ProjectNumber`
// (../projects#FirebaseProject.FIELDS.project_number)
// ***(recommended)*** or its `ProjectId`
// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
// using project identifiers in Google's AIP 2510 standard
// (https://google.aip.dev/cloud/2510). Note that the value for
// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
// APP_ID: the globally unique, Firebase-assigned identifier for the App
// (see `appId` (../projects.androidApps#AndroidApp.FIELDS.app_id)).
Name string `json:"name,omitempty"`
// PackageName: Immutable. The canonical package name of the Android app
// as would appear in the Google Play Developer Console.
PackageName string `json:"packageName,omitempty"`
// ProjectId: Immutable. A user-assigned unique identifier of the parent
// FirebaseProject for the `AndroidApp`.
ProjectId string `json:"projectId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ApiKeyId") 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. "ApiKeyId") 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 *AndroidApp) MarshalJSON() ([]byte, error) {
type NoMethod AndroidApp
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// AndroidAppConfig: Configuration metadata of a single Firebase App for
// Android.
type AndroidAppConfig struct {
// ConfigFileContents: The contents of the JSON configuration file.
ConfigFileContents string `json:"configFileContents,omitempty"`
// ConfigFilename: The filename that the configuration artifact for the
// `AndroidApp` is typically saved as. For example:
// `google-services.json`
ConfigFilename string `json:"configFilename,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
// 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. "ConfigFileContents") 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 *AndroidAppConfig) MarshalJSON() ([]byte, error) {
type NoMethod AndroidAppConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DefaultResources: The default resources associated with the Project.
type DefaultResources struct {
// HostingSite: The default Firebase Hosting site name, in the format:
// PROJECT_ID Though rare, your `projectId` might already be used as the
// name for an existing Hosting site in another project (learn more
// about creating non-default, additional sites
// (https://firebase.google.com/docs/hosting/multisites)). In these
// cases, your `projectId` is appended with a hyphen then five
// alphanumeric characters to create your default Hosting site name. For
// example, if your `projectId` is `myproject123`, your default Hosting
// site name might be: `myproject123-a5c16`
HostingSite string `json:"hostingSite,omitempty"`
// LocationId: The ID of the Project's default GCP resource location.
// The location is one of the available GCP resource locations
// (https://firebase.google.com/docs/projects/locations). This field is
// omitted if the default GCP resource location has not been finalized
// yet. To set a Project's default GCP resource location, call
// `FinalizeDefaultLocation` (../projects.defaultLocation/finalize)
// after you add Firebase resources to the Project.
LocationId string `json:"locationId,omitempty"`
// RealtimeDatabaseInstance: The default Firebase Realtime Database
// instance name, in the format: PROJECT_ID Though rare, your
// `projectId` might already be used as the name for an existing
// Realtime Database instance in another project (learn more about
// database sharding
// (https://firebase.google.com/docs/database/usage/sharding)). In these
// cases, your `projectId` is appended with a hyphen then five
// alphanumeric characters to create your default Realtime Database
// instance name. For example, if your `projectId` is `myproject123`,
// your default database instance name might be: `myproject123-a5c16`
RealtimeDatabaseInstance string `json:"realtimeDatabaseInstance,omitempty"`
// StorageBucket: The default Cloud Storage for Firebase storage bucket,
// in the format: PROJECT_ID.appspot.com
StorageBucket string `json:"storageBucket,omitempty"`
// ForceSendFields is a list of field names (e.g. "HostingSite") 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. "HostingSite") 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 *DefaultResources) MarshalJSON() ([]byte, error) {
type NoMethod DefaultResources
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:"-"`
}
type FinalizeDefaultLocationRequest struct {
// LocationId: The ID of the Project's default GCP resource location.
// The location must be one of the available GCP resource locations
// (https://firebase.google.com/docs/projects/locations).
LocationId string `json:"locationId,omitempty"`
// ForceSendFields is a list of field names (e.g. "LocationId") 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. "LocationId") 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 *FinalizeDefaultLocationRequest) MarshalJSON() ([]byte, error) {
type NoMethod FinalizeDefaultLocationRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FirebaseAppInfo: A high-level summary of an App.
type FirebaseAppInfo struct {
// AppId: Output only. Immutable. The globally unique, Firebase-assigned
// identifier for the `WebApp`. This identifier should be treated as an
// opaque token, as the data format is not specified.
AppId string `json:"appId,omitempty"`
// DisplayName: The user-assigned display name of the Firebase App.
DisplayName string `json:"displayName,omitempty"`
// Name: The resource name of the Firebase App, in the format:
// projects/PROJECT_ID /iosApps/APP_ID or
// projects/PROJECT_ID/androidApps/APP_ID or projects/
// PROJECT_ID/webApps/APP_ID
Name string `json:"name,omitempty"`
// Namespace: Output only. Immutable. The platform-specific identifier
// of the App. *Note:* For most use cases, use `appId`, which is the
// canonical, globally unique identifier for referencing an App. This
// string is derived from a native identifier for each platform:
// `packageName` for an `AndroidApp`, `bundleId` for an `IosApp`, and
// `webId` for a `WebApp`. Its contents should be treated as opaque, as
// the native identifier format may change as platforms evolve. This
// string is only unique within a `FirebaseProject` and its associated
// Apps.
Namespace string `json:"namespace,omitempty"`
// Platform: The platform of the Firebase App.
//
// Possible values:
// "PLATFORM_UNSPECIFIED" - Unknown state. This is only used for
// distinguishing unset values.
// "IOS" - The Firebase App is associated with iOS.
// "ANDROID" - The Firebase App is associated with Android.
// "WEB" - The Firebase App is associated with web.
Platform string `json:"platform,omitempty"`
// ForceSendFields is a list of field names (e.g. "AppId") 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. "AppId") 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 *FirebaseAppInfo) MarshalJSON() ([]byte, error) {
type NoMethod FirebaseAppInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FirebaseProject: A `FirebaseProject` is the top-level Firebase
// entity. It is the container for Firebase Apps, Firebase Hosting
// sites, storage systems (Firebase Realtime Database, Cloud Firestore,
// Cloud Storage buckets), and other Firebase and Google Cloud Platform
// (GCP) resources. You create a `FirebaseProject` by calling
// AddFirebase and specifying an *existing* GCP `Project`
// (https://cloud.google.com/resource-manager/reference/rest/v1/projects).
// This adds Firebase resources to the existing GCP `Project`. Since a
// FirebaseProject is actually also a GCP `Project`, a `FirebaseProject`
// has the same underlying GCP identifiers (`projectNumber` and
// `projectId`). This allows for easy interop with Google APIs.
type FirebaseProject struct {
// DisplayName: The user-assigned display name of the Project.
DisplayName string `json:"displayName,omitempty"`
// Name: The resource name of the Project, in the format:
// projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's
// `ProjectNumber` (../projects#FirebaseProject.FIELDS.project_number)
// ***(recommended)*** or its `ProjectId`
// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
// using project identifiers in Google's AIP 2510 standard
// (https://google.aip.dev/cloud/2510). Note that the value for
// PROJECT_IDENTIFIER in any response body will be the `ProjectId`.
Name string `json:"name,omitempty"`
// ProjectId: Immutable. A user-assigned unique identifier for the
// Project. This identifier may appear in URLs or names for some
// Firebase resources associated with the Project, but it should
// generally be treated as a convenience alias to reference the Project.
ProjectId string `json:"projectId,omitempty"`
// ProjectNumber: Immutable. The globally unique, Google-assigned
// canonical identifier for the Project. Use this identifier when
// configuring integrations and/or making API calls to Firebase or
// third-party services.
ProjectNumber int64 `json:"projectNumber,omitempty,string"`
// Resources: The default Firebase resources associated with the
// Project.
Resources *DefaultResources `json:"resources,omitempty"`
// State: Output only. The lifecycle state of the Project. Updates to
// the state must be performed via
// com.google.cloudresourcemanager.v1.Projects.DeleteProject and
// com.google.cloudresourcemanager.v1.Projects.UndeleteProject
//
// Possible values:
// "STATE_UNSPECIFIED" - Unspecified state.
// "ACTIVE" - The normal and active state.
// "DELETED" - The Project has been marked for deletion by the user.
State string `json:"state,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DisplayName") 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. "DisplayName") 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 *FirebaseProject) MarshalJSON() ([]byte, error) {
type NoMethod FirebaseProject
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// IosApp: Details of a Firebase App for iOS.
type IosApp struct {
// ApiKeyId: The key_id of the GCP ApiKey associated with this App. If
// set must have no restrictions, or only have restrictions that are
// valid for the associated Firebase App. Cannot be set in create
// requests, instead an existing valid API Key will be chosen, or if no
// valid API Keys exist, one will be provisioned for you. Cannot be set
// to an empty value in update requests.
ApiKeyId string `json:"apiKeyId,omitempty"`
// AppId: Immutable. The globally unique, Firebase-assigned identifier
// for the `IosApp`. This identifier should be treated as an opaque
// token, as the data format is not specified.
AppId string `json:"appId,omitempty"`
// AppStoreId: The automatically generated Apple ID assigned to the iOS
// app by Apple in the iOS App Store.
AppStoreId string `json:"appStoreId,omitempty"`
// BundleId: Immutable. The canonical bundle ID of the iOS app as it
// would appear in the iOS AppStore.
BundleId string `json:"bundleId,omitempty"`
// DisplayName: The user-assigned display name for the `IosApp`.
DisplayName string `json:"displayName,omitempty"`
// Name: The resource name of the IosApp, in the format:
// projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the
// parent Project's `ProjectNumber`
// (../projects#FirebaseProject.FIELDS.project_number)
// ***(recommended)*** or its `ProjectId`
// (../projects#FirebaseProject.FIELDS.project_id). Learn more about
// using project identifiers in Google's AIP 2510 standard
// (https://google.aip.dev/cloud/2510). Note that the value for
// PROJECT_IDENTIFIER in any response body will be the `ProjectId`. *
// APP_ID: the globally unique, Firebase-assigned identifier for the App
// (see `appId` (../projects.iosApps#IosApp.FIELDS.app_id)).
Name string `json:"name,omitempty"`
// ProjectId: Immutable. A user-assigned unique identifier of the parent
// FirebaseProject for the `IosApp`.
ProjectId string `json:"projectId,omitempty"`
// TeamId: The Apple Developer Team ID associated with the App in the
// App Store.
TeamId string `json:"teamId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ApiKeyId") 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. "ApiKeyId") 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 *IosApp) MarshalJSON() ([]byte, error) {
type NoMethod IosApp
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// IosAppConfig: Configuration metadata of a single Firebase App for
// iOS.
type IosAppConfig struct {
// ConfigFileContents: The content of the XML configuration file.
ConfigFileContents string `json:"configFileContents,omitempty"`
// ConfigFilename: The filename that the configuration artifact for the
// `IosApp` is typically saved as. For example:
// `GoogleService-Info.plist`
ConfigFilename string `json:"configFilename,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ConfigFileContents")
// 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. "ConfigFileContents") 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 *IosAppConfig) MarshalJSON() ([]byte, error) {
type NoMethod IosAppConfig
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListAndroidAppsResponse struct {
// Apps: List of each `AndroidApp` associated with the specified
// `FirebaseProject`.
Apps []*AndroidApp `json:"apps,omitempty"`
// NextPageToken: If the result list is too large to fit in a single
// response, then a token is returned. If the string is empty, then this
// response is the last page of results. This token can be used in a
// subsequent call to `ListAndroidApps` to find the next group of Apps.
// Page tokens are short-lived and should not be persisted.
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. "Apps") 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. "Apps") 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 *ListAndroidAppsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListAndroidAppsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ListAvailableLocationsResponse struct {
// Locations: One page of results from a call to
// `ListAvailableLocations`.
Locations []*Location `json:"locations,omitempty"`
// NextPageToken: If the result list is too large to fit in a single
// response, then a token is returned. If the string is empty, then this
// response is the last page of results and all available locations have
// been listed. This token can be used in a subsequent call to
// `ListAvailableLocations` to find more locations. Page tokens are
// short-lived and should not be persisted.
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. "Locations") 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. "Locations") 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 *ListAvailableLocationsResponse) MarshalJSON() ([]byte, error) {