-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
Copy pathfirebaserules-gen.go
2949 lines (2693 loc) · 103 KB
/
firebaserules-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 firebaserules provides access to the Firebase Rules API.
//
// For product documentation, see: https://firebase.google.com/docs/storage/security
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/firebaserules/v1"
// ...
// ctx := context.Background()
// firebaserulesService, err := firebaserules.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:
//
// firebaserulesService, err := firebaserules.NewService(ctx, option.WithScopes(firebaserules.FirebaseReadonlyScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// firebaserulesService, err := firebaserules.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, ...)
// firebaserulesService, err := firebaserules.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package firebaserules // import "google.golang.org/api/firebaserules/v1"
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 = "firebaserules:v1"
const apiName = "firebaserules"
const apiVersion = "v1"
const basePath = "https://firebaserules.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 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/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.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
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Releases = NewProjectsReleasesService(s)
rs.Rulesets = NewProjectsRulesetsService(s)
return rs
}
type ProjectsService struct {
s *Service
Releases *ProjectsReleasesService
Rulesets *ProjectsRulesetsService
}
func NewProjectsReleasesService(s *Service) *ProjectsReleasesService {
rs := &ProjectsReleasesService{s: s}
return rs
}
type ProjectsReleasesService struct {
s *Service
}
func NewProjectsRulesetsService(s *Service) *ProjectsRulesetsService {
rs := &ProjectsRulesetsService{s: s}
return rs
}
type ProjectsRulesetsService struct {
s *Service
}
// Arg: Arg matchers for the mock function.
type Arg struct {
// AnyValue: Argument matches any value provided.
AnyValue *Empty `json:"anyValue,omitempty"`
// ExactValue: Argument exactly matches value provided.
ExactValue interface{} `json:"exactValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "AnyValue") 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. "AnyValue") 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 *Arg) MarshalJSON() ([]byte, error) {
type NoMethod Arg
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:"-"`
}
// File: `File` containing source content.
type File struct {
// Content: Textual Content.
Content string `json:"content,omitempty"`
// Fingerprint: Fingerprint (e.g. github sha) associated with the
// `File`.
Fingerprint string `json:"fingerprint,omitempty"`
// Name: File name.
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Content") 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. "Content") 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 *File) MarshalJSON() ([]byte, error) {
type NoMethod File
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FunctionCall: Represents a service-defined function call that was
// invoked during test
// execution.
type FunctionCall struct {
// Args: The arguments that were provided to the function.
Args []interface{} `json:"args,omitempty"`
// Function: Name of the function invoked.
Function string `json:"function,omitempty"`
// ForceSendFields is a list of field names (e.g. "Args") 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. "Args") 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 *FunctionCall) MarshalJSON() ([]byte, error) {
type NoMethod FunctionCall
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FunctionMock: Mock function definition.
//
// Mocks must refer to a function declared by the target service. The
// type of
// the function args and result will be inferred at test time. If either
// the
// arg or result values are not compatible with function type
// declaration, the
// request will be considered invalid.
//
// More than one `FunctionMock` may be provided for a given function
// name so
// long as the `Arg` matchers are distinct. There may be only one
// function
// for a given overload where all `Arg` values are `Arg.any_value`.
type FunctionMock struct {
// Args: The list of `Arg` values to match. The order in which the
// arguments are
// provided is the order in which they must appear in the
// function
// invocation.
Args []*Arg `json:"args,omitempty"`
// Function: The name of the function.
//
// The function name must match one provided by a service declaration.
Function string `json:"function,omitempty"`
// Result: The mock result of the function call.
Result *Result `json:"result,omitempty"`
// ForceSendFields is a list of field names (e.g. "Args") 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. "Args") 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 *FunctionMock) MarshalJSON() ([]byte, error) {
type NoMethod FunctionMock
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// GetReleaseExecutableResponse: The response for
// FirebaseRulesService.GetReleaseExecutable
type GetReleaseExecutableResponse struct {
// Executable: Executable view of the `Ruleset` referenced by the
// `Release`.
Executable string `json:"executable,omitempty"`
// ExecutableVersion: The Rules runtime version of the executable.
//
// Possible values:
// "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED" - Executable format
// unspecified.
// Defaults to FIREBASE_RULES_EXECUTABLE_V1
// "FIREBASE_RULES_EXECUTABLE_V1" - Firebase Rules syntax 'rules2'
// executable versions:
// Custom AST for use with Java clients.
// "FIREBASE_RULES_EXECUTABLE_V2" - CEL-based executable for use with
// C++ clients.
ExecutableVersion string `json:"executableVersion,omitempty"`
// Language: `Language` used to generate the executable bytes.
//
// Possible values:
// "LANGUAGE_UNSPECIFIED" - Language unspecified. Defaults to
// FIREBASE_RULES.
// "FIREBASE_RULES" - Firebase Rules language.
// "EVENT_FLOW_TRIGGERS" - Event Flow triggers.
Language string `json:"language,omitempty"`
// RulesetName: `Ruleset` name associated with the `Release` executable.
RulesetName string `json:"rulesetName,omitempty"`
// SyncTime: Optional, indicates the freshness of the result. The
// response is
// guaranteed to be the latest within an interval up to the
// sync_time (inclusive).
SyncTime string `json:"syncTime,omitempty"`
// UpdateTime: Timestamp for the most recent `Release.update_time`.
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. "Executable") 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. "Executable") 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 *GetReleaseExecutableResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetReleaseExecutableResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Issue: Issues include warnings, errors, and deprecation notices.
type Issue struct {
// Description: Short error description.
Description string `json:"description,omitempty"`
// Severity: The severity of the issue.
//
// Possible values:
// "SEVERITY_UNSPECIFIED" - An unspecified severity.
// "DEPRECATION" - Deprecation issue for statements and method that
// may no longer be
// supported or maintained.
// "WARNING" - Warnings such as: unused variables.
// "ERROR" - Errors such as: unmatched curly braces or variable
// redefinition.
Severity string `json:"severity,omitempty"`
// SourcePosition: Position of the issue in the `Source`.
SourcePosition *SourcePosition `json:"sourcePosition,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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 *Issue) MarshalJSON() ([]byte, error) {
type NoMethod Issue
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ListReleasesResponse: The response for
// FirebaseRulesService.ListReleases.
type ListReleasesResponse struct {
// NextPageToken: The pagination token to retrieve the next page of
// results. If the value is
// empty, no further results remain.
NextPageToken string `json:"nextPageToken,omitempty"`
// Releases: List of `Release` instances.
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)
}
// ListRulesetsResponse: The response for
// FirebaseRulesService.ListRulesets.
type ListRulesetsResponse struct {
// NextPageToken: The pagination token to retrieve the next page of
// results. If the value is
// empty, no further results remain.
NextPageToken string `json:"nextPageToken,omitempty"`
// Rulesets: List of `Ruleset` instances.
Rulesets []*Ruleset `json:"rulesets,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 *ListRulesetsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListRulesetsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Release: `Release` is a named reference to a `Ruleset`. Once a
// `Release` refers to a
// `Ruleset`, rules-enabled services will be able to enforce the
// `Ruleset`.
type Release struct {
// CreateTime: Time the release was created.
// Output only.
CreateTime string `json:"createTime,omitempty"`
// Name: Resource name for the `Release`.
//
// `Release` names may be structured `app1/prod/v2` or flat
// `app1_prod_v2`
// which affords developers a great deal of flexibility in mapping the
// name
// to the style that best fits their existing development practices.
// For
// example, a name could refer to an environment, an app, a version, or
// some
// combination of three.
//
// In the table below, for the project name `projects/foo`, the
// following
// relative release paths show how flat and structured names might be
// chosen
// to match a desired development / deployment strategy.
//
// Use Case | Flat Name | Structured
// Name
// -------------|---------------------|----------------
// Environments
// | releases/qa | releases/qa
// Apps | releases/app1_qa | releases/app1/qa
// Versions | releases/app1_v2_qa | releases/app1/v2/qa
//
// The delimiter between the release name path elements can be almost
// anything
// and it should work equally well with the release name list filter,
// but in
// many ways the structured paths provide a clearer picture of
// the
// relationship between `Release` instances.
//
// Format: `projects/{project_id}/releases/{release_id}`
Name string `json:"name,omitempty"`
// RulesetName: Name of the `Ruleset` referred to by this `Release`. The
// `Ruleset` must
// exist the `Release` to be created.
RulesetName string `json:"rulesetName,omitempty"`
// UpdateTime: Time the release was updated.
// Output only.
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. "CreateTime") 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. "CreateTime") 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)
}
// Result: Possible result values from the function mock invocation.
type Result struct {
// Undefined: The result is undefined, meaning the result could not be
// computed.
Undefined *Empty `json:"undefined,omitempty"`
// Value: The result is an actual value. The type of the value must
// match that
// of the type declared by the service.
Value interface{} `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Undefined") 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. "Undefined") 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 *Result) MarshalJSON() ([]byte, error) {
type NoMethod Result
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Ruleset: `Ruleset` is an immutable copy of `Source` with a globally
// unique identifier
// and a creation time.
type Ruleset struct {
// CreateTime: Time the `Ruleset` was created.
// Output only.
CreateTime string `json:"createTime,omitempty"`
// Name: Name of the `Ruleset`. The ruleset_id is auto generated by the
// service.
// Format: `projects/{project_id}/rulesets/{ruleset_id}`
// Output only.
Name string `json:"name,omitempty"`
// Source: `Source` for the `Ruleset`.
Source *Source `json:"source,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *Ruleset) MarshalJSON() ([]byte, error) {
type NoMethod Ruleset
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// Source: `Source` is one or more `File` messages comprising a logical
// set of rules.
type Source struct {
// Files: `File` set constituting the `Source` bundle.
Files []*File `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 *Source) MarshalJSON() ([]byte, error) {
type NoMethod Source
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// SourcePosition: Position in the `Source` content including its line,
// column number, and an
// index of the `File` in the `Source` message. Used for debug purposes.
type SourcePosition struct {
// Column: First column on the source line associated with the source
// fragment.
Column int64 `json:"column,omitempty"`
// FileName: Name of the `File`.
FileName string `json:"fileName,omitempty"`
// Line: Line number of the source fragment. 1-based.
Line int64 `json:"line,omitempty"`
// ForceSendFields is a list of field names (e.g. "Column") 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. "Column") 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 *SourcePosition) MarshalJSON() ([]byte, error) {
type NoMethod SourcePosition
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// TestCase: `TestCase` messages provide the request context and an
// expectation as to
// whether the given context will be allowed or denied. Test cases may
// specify
// the `request`, `resource`, and `function_mocks` to mock a function
// call to
// a service-provided function.
//
// The `request` object represents context present at request-time.
//
// The `resource` is the value of the target resource as it appears
// in
// persistent storage before the request is executed.
type TestCase struct {
// Expectation: Test expectation.
//
// Possible values:
// "EXPECTATION_UNSPECIFIED" - Unspecified expectation.
// "ALLOW" - Expect an allowed result.
// "DENY" - Expect a denied result.
Expectation string `json:"expectation,omitempty"`
// FunctionMocks: Optional function mocks for service-defined functions.
// If not set, any
// service defined function is expected to return an error, which may or
// may
// not influence the test outcome.
FunctionMocks []*FunctionMock `json:"functionMocks,omitempty"`
// Request: Request context.
//
// The exact format of the request context is service-dependent. See
// the
// appropriate service documentation for information about the
// supported
// fields and types on the request. Minimally, all services support
// the
// following fields and types:
//
// Request field | Type
// ---------------|-----------------
// auth.uid | `string`
// auth.token | `map<string, string>`
// headers | `map<string, string>`
// method | `string`
// params | `map<string, string>`
// path | `string`
// time | `google.protobuf.Timestamp`
//
// If the request value is not well-formed for the service, the request
// will
// be rejected as an invalid argument.
Request interface{} `json:"request,omitempty"`
// Resource: Optional resource value as it appears in persistent storage
// before the
// request is fulfilled.
//
// The resource type depends on the `request.path` value.
Resource interface{} `json:"resource,omitempty"`
// ForceSendFields is a list of field names (e.g. "Expectation") 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. "Expectation") 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 *TestCase) MarshalJSON() ([]byte, error) {
type NoMethod TestCase
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// TestResult: Test result message containing the state of the test as
// well as a
// description and source position for test failures.
type TestResult struct {
// DebugMessages: Debug messages related to test execution issues
// encountered during
// evaluation.
//
// Debug messages may be related to too many or too few invocations
// of
// function mocks or to runtime errors that occur during
// evaluation.
//
// For example: ```Unable to read variable [name: "resource"]```
DebugMessages []string `json:"debugMessages,omitempty"`
// ErrorPosition: Position in the `Source` or `Ruleset` where the
// principle runtime error
// occurs.
//
// Evaluation of an expression may result in an error. Rules are deny
// by
// default, so a `DENY` expectation when an error is generated is
// valid.
// When there is a `DENY` with an error, the `SourcePosition` is
// returned.
//
// E.g. `error_position { line: 19 column: 37 }`
ErrorPosition *SourcePosition `json:"errorPosition,omitempty"`
// FunctionCalls: The set of function calls made to service-defined
// methods.
//
// Function calls are included in the order in which they are
// encountered
// during evaluation, are provided for both mocked and unmocked
// functions,
// and included on the response regardless of the test `state`.
FunctionCalls []*FunctionCall `json:"functionCalls,omitempty"`
// State: State of the test.
//
// Possible values:
// "STATE_UNSPECIFIED" - Test state is not set.
// "SUCCESS" - Test is a success.
// "FAILURE" - Test is a failure.
State string `json:"state,omitempty"`
// VisitedExpressions: The set of visited permission expressions for a
// given test. This returns
// the positions and evaluation results of all visited
// permission
// expressions which were relevant to the test case, e.g.
// ```
// match /path {
// allow read if: <expr>
// }
// ```
// For a detailed report of the intermediate evaluation states, see
// the
// `expression_reports` field
VisitedExpressions []*VisitedExpression `json:"visitedExpressions,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugMessages") 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. "DebugMessages") 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 *TestResult) MarshalJSON() ([]byte, error) {
type NoMethod TestResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// TestRulesetRequest: The request for FirebaseRulesService.TestRuleset.
type TestRulesetRequest struct {
// Source: Optional `Source` to be checked for correctness.
//
// This field must not be set when the resource name refers to a
// `Ruleset`.
Source *Source `json:"source,omitempty"`
// TestSuite: Inline `TestSuite` to run.
TestSuite *TestSuite `json:"testSuite,omitempty"`
// ForceSendFields is a list of field names (e.g. "Source") 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. "Source") 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 *TestRulesetRequest) MarshalJSON() ([]byte, error) {
type NoMethod TestRulesetRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// TestRulesetResponse: The response for
// FirebaseRulesService.TestRuleset.
type TestRulesetResponse struct {
// Issues: Syntactic and semantic `Source` issues of varying severity.
// Issues of
// `ERROR` severity will prevent tests from executing.
Issues []*Issue `json:"issues,omitempty"`
// TestResults: The set of test results given the test cases in the
// `TestSuite`.
// The results will appear in the same order as the test cases appear in
// the
// `TestSuite`.
TestResults []*TestResult `json:"testResults,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Issues") 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. "Issues") 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:"-"`
}