File: classes.rb

package info (click to toggle)
ruby-google-api-client 0.53.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 75,020 kB
  • sloc: ruby: 626,567; makefile: 4
file content (825 lines) | stat: -rw-r--r-- 33,086 bytes parent folder | download | duplicates (2)
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
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'

module Google
  module Apis
    module FirebaserulesV1
      
      # Arg matchers for the mock function.
      class Arg
        include Google::Apis::Core::Hashable
      
        # 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 ````.
        # Corresponds to the JSON property `anyValue`
        # @return [Google::Apis::FirebaserulesV1::Empty]
        attr_accessor :any_value
      
        # Argument exactly matches value provided.
        # Corresponds to the JSON property `exactValue`
        # @return [Object]
        attr_accessor :exact_value
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @any_value = args[:any_value] if args.key?(:any_value)
          @exact_value = args[:exact_value] if args.key?(:exact_value)
        end
      end
      
      # 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 ````.
      class Empty
        include Google::Apis::Core::Hashable
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
        end
      end
      
      # Describes where in a file an expression is found and what it was evaluated to
      # over the course of its use.
      class ExpressionReport
        include Google::Apis::Core::Hashable
      
        # Subexpressions
        # Corresponds to the JSON property `children`
        # @return [Array<Google::Apis::FirebaserulesV1::ExpressionReport>]
        attr_accessor :children
      
        # Position in the `Source` content including its line, column number, and an
        # index of the `File` in the `Source` message. Used for debug purposes.
        # Corresponds to the JSON property `sourcePosition`
        # @return [Google::Apis::FirebaserulesV1::SourcePosition]
        attr_accessor :source_position
      
        # Values that this expression evaluated to when encountered.
        # Corresponds to the JSON property `values`
        # @return [Array<Google::Apis::FirebaserulesV1::ValueCount>]
        attr_accessor :values
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @children = args[:children] if args.key?(:children)
          @source_position = args[:source_position] if args.key?(:source_position)
          @values = args[:values] if args.key?(:values)
        end
      end
      
      # `File` containing source content.
      class File
        include Google::Apis::Core::Hashable
      
        # Textual Content.
        # Corresponds to the JSON property `content`
        # @return [String]
        attr_accessor :content
      
        # Fingerprint (e.g. github sha) associated with the `File`.
        # Corresponds to the JSON property `fingerprint`
        # NOTE: Values are automatically base64 encoded/decoded in the client library.
        # @return [String]
        attr_accessor :fingerprint
      
        # File name.
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @content = args[:content] if args.key?(:content)
          @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
          @name = args[:name] if args.key?(:name)
        end
      end
      
      # Represents a service-defined function call that was invoked during test
      # execution.
      class FunctionCall
        include Google::Apis::Core::Hashable
      
        # The arguments that were provided to the function.
        # Corresponds to the JSON property `args`
        # @return [Array<Object>]
        attr_accessor :args
      
        # Name of the function invoked.
        # Corresponds to the JSON property `function`
        # @return [String]
        attr_accessor :function
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @args = args[:args] if args.key?(:args)
          @function = args[:function] if args.key?(:function)
        end
      end
      
      # 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`.
      class FunctionMock
        include Google::Apis::Core::Hashable
      
        # 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.
        # Corresponds to the JSON property `args`
        # @return [Array<Google::Apis::FirebaserulesV1::Arg>]
        attr_accessor :args
      
        # The name of the function. The function name must match one provided by a
        # service declaration.
        # Corresponds to the JSON property `function`
        # @return [String]
        attr_accessor :function
      
        # Possible result values from the function mock invocation.
        # Corresponds to the JSON property `result`
        # @return [Google::Apis::FirebaserulesV1::Result]
        attr_accessor :result
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @args = args[:args] if args.key?(:args)
          @function = args[:function] if args.key?(:function)
          @result = args[:result] if args.key?(:result)
        end
      end
      
      # The response for FirebaseRulesService.GetReleaseExecutable
      class GetReleaseExecutableResponse
        include Google::Apis::Core::Hashable
      
        # Executable view of the `Ruleset` referenced by the `Release`.
        # Corresponds to the JSON property `executable`
        # NOTE: Values are automatically base64 encoded/decoded in the client library.
        # @return [String]
        attr_accessor :executable
      
        # The Rules runtime version of the executable.
        # Corresponds to the JSON property `executableVersion`
        # @return [String]
        attr_accessor :executable_version
      
        # `Language` used to generate the executable bytes.
        # Corresponds to the JSON property `language`
        # @return [String]
        attr_accessor :language
      
        # `Ruleset` name associated with the `Release` executable.
        # Corresponds to the JSON property `rulesetName`
        # @return [String]
        attr_accessor :ruleset_name
      
        # Optional, indicates the freshness of the result. The response is guaranteed to
        # be the latest within an interval up to the sync_time (inclusive).
        # Corresponds to the JSON property `syncTime`
        # @return [String]
        attr_accessor :sync_time
      
        # Timestamp for the most recent `Release.update_time`.
        # Corresponds to the JSON property `updateTime`
        # @return [String]
        attr_accessor :update_time
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @executable = args[:executable] if args.key?(:executable)
          @executable_version = args[:executable_version] if args.key?(:executable_version)
          @language = args[:language] if args.key?(:language)
          @ruleset_name = args[:ruleset_name] if args.key?(:ruleset_name)
          @sync_time = args[:sync_time] if args.key?(:sync_time)
          @update_time = args[:update_time] if args.key?(:update_time)
        end
      end
      
      # Issues include warnings, errors, and deprecation notices.
      class Issue
        include Google::Apis::Core::Hashable
      
        # Short error description.
        # Corresponds to the JSON property `description`
        # @return [String]
        attr_accessor :description
      
        # The severity of the issue.
        # Corresponds to the JSON property `severity`
        # @return [String]
        attr_accessor :severity
      
        # Position in the `Source` content including its line, column number, and an
        # index of the `File` in the `Source` message. Used for debug purposes.
        # Corresponds to the JSON property `sourcePosition`
        # @return [Google::Apis::FirebaserulesV1::SourcePosition]
        attr_accessor :source_position
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @description = args[:description] if args.key?(:description)
          @severity = args[:severity] if args.key?(:severity)
          @source_position = args[:source_position] if args.key?(:source_position)
        end
      end
      
      # The response for FirebaseRulesService.ListReleases.
      class ListReleasesResponse
        include Google::Apis::Core::Hashable
      
        # The pagination token to retrieve the next page of results. If the value is
        # empty, no further results remain.
        # Corresponds to the JSON property `nextPageToken`
        # @return [String]
        attr_accessor :next_page_token
      
        # List of `Release` instances.
        # Corresponds to the JSON property `releases`
        # @return [Array<Google::Apis::FirebaserulesV1::Release>]
        attr_accessor :releases
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
          @releases = args[:releases] if args.key?(:releases)
        end
      end
      
      # The response for FirebaseRulesService.ListRulesets.
      class ListRulesetsResponse
        include Google::Apis::Core::Hashable
      
        # The pagination token to retrieve the next page of results. If the value is
        # empty, no further results remain.
        # Corresponds to the JSON property `nextPageToken`
        # @return [String]
        attr_accessor :next_page_token
      
        # List of `Ruleset` instances.
        # Corresponds to the JSON property `rulesets`
        # @return [Array<Google::Apis::FirebaserulesV1::Ruleset>]
        attr_accessor :rulesets
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
          @rulesets = args[:rulesets] if args.key?(:rulesets)
        end
      end
      
      # Metadata for a Ruleset.
      class Metadata
        include Google::Apis::Core::Hashable
      
        # Services that this ruleset has declarations for (e.g., "cloud.firestore").
        # There may be 0+ of these.
        # Corresponds to the JSON property `services`
        # @return [Array<String>]
        attr_accessor :services
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @services = args[:services] if args.key?(:services)
        end
      end
      
      # `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`.
      class Release
        include Google::Apis::Core::Hashable
      
        # Time the release was created. Output only.
        # Corresponds to the JSON property `createTime`
        # @return [String]
        attr_accessor :create_time
      
        # 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``
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist
        # the `Release` to be created.
        # Corresponds to the JSON property `rulesetName`
        # @return [String]
        attr_accessor :ruleset_name
      
        # Time the release was updated. Output only.
        # Corresponds to the JSON property `updateTime`
        # @return [String]
        attr_accessor :update_time
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @create_time = args[:create_time] if args.key?(:create_time)
          @name = args[:name] if args.key?(:name)
          @ruleset_name = args[:ruleset_name] if args.key?(:ruleset_name)
          @update_time = args[:update_time] if args.key?(:update_time)
        end
      end
      
      # Possible result values from the function mock invocation.
      class Result
        include Google::Apis::Core::Hashable
      
        # 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 ````.
        # Corresponds to the JSON property `undefined`
        # @return [Google::Apis::FirebaserulesV1::Empty]
        attr_accessor :undefined
      
        # The result is an actual value. The type of the value must match that of the
        # type declared by the service.
        # Corresponds to the JSON property `value`
        # @return [Object]
        attr_accessor :value
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @undefined = args[:undefined] if args.key?(:undefined)
          @value = args[:value] if args.key?(:value)
        end
      end
      
      # `Ruleset` is an immutable copy of `Source` with a globally unique identifier
      # and a creation time.
      class Ruleset
        include Google::Apis::Core::Hashable
      
        # Time the `Ruleset` was created. Output only.
        # Corresponds to the JSON property `createTime`
        # @return [String]
        attr_accessor :create_time
      
        # Metadata for a Ruleset.
        # Corresponds to the JSON property `metadata`
        # @return [Google::Apis::FirebaserulesV1::Metadata]
        attr_accessor :metadata
      
        # Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format:
        # `projects/`project_id`/rulesets/`ruleset_id`` Output only.
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        # `Source` is one or more `File` messages comprising a logical set of rules.
        # Corresponds to the JSON property `source`
        # @return [Google::Apis::FirebaserulesV1::Source]
        attr_accessor :source
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @create_time = args[:create_time] if args.key?(:create_time)
          @metadata = args[:metadata] if args.key?(:metadata)
          @name = args[:name] if args.key?(:name)
          @source = args[:source] if args.key?(:source)
        end
      end
      
      # `Source` is one or more `File` messages comprising a logical set of rules.
      class Source
        include Google::Apis::Core::Hashable
      
        # `File` set constituting the `Source` bundle.
        # Corresponds to the JSON property `files`
        # @return [Array<Google::Apis::FirebaserulesV1::File>]
        attr_accessor :files
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @files = args[:files] if args.key?(:files)
        end
      end
      
      # Position in the `Source` content including its line, column number, and an
      # index of the `File` in the `Source` message. Used for debug purposes.
      class SourcePosition
        include Google::Apis::Core::Hashable
      
        # First column on the source line associated with the source fragment.
        # Corresponds to the JSON property `column`
        # @return [Fixnum]
        attr_accessor :column
      
        # Start position relative to the beginning of the file.
        # Corresponds to the JSON property `currentOffset`
        # @return [Fixnum]
        attr_accessor :current_offset
      
        # End position relative to the beginning of the file.
        # Corresponds to the JSON property `endOffset`
        # @return [Fixnum]
        attr_accessor :end_offset
      
        # Name of the `File`.
        # Corresponds to the JSON property `fileName`
        # @return [String]
        attr_accessor :file_name
      
        # Line number of the source fragment. 1-based.
        # Corresponds to the JSON property `line`
        # @return [Fixnum]
        attr_accessor :line
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @column = args[:column] if args.key?(:column)
          @current_offset = args[:current_offset] if args.key?(:current_offset)
          @end_offset = args[:end_offset] if args.key?(:end_offset)
          @file_name = args[:file_name] if args.key?(:file_name)
          @line = args[:line] if args.key?(:line)
        end
      end
      
      # `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.
      class TestCase
        include Google::Apis::Core::Hashable
      
        # Test expectation.
        # Corresponds to the JSON property `expectation`
        # @return [String]
        attr_accessor :expectation
      
        # Specifies what should be included in the response.
        # Corresponds to the JSON property `expressionReportLevel`
        # @return [String]
        attr_accessor :expression_report_level
      
        # 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.
        # Corresponds to the JSON property `functionMocks`
        # @return [Array<Google::Apis::FirebaserulesV1::FunctionMock>]
        attr_accessor :function_mocks
      
        # Specifies whether paths (such as request.path) are encoded and how.
        # Corresponds to the JSON property `pathEncoding`
        # @return [String]
        attr_accessor :path_encoding
      
        # 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` headers | `map` method | `string` params | `
        # map` 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.
        # Corresponds to the JSON property `request`
        # @return [Object]
        attr_accessor :request
      
        # Optional resource value as it appears in persistent storage before the request
        # is fulfilled. The resource type depends on the `request.path` value.
        # Corresponds to the JSON property `resource`
        # @return [Object]
        attr_accessor :resource
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @expectation = args[:expectation] if args.key?(:expectation)
          @expression_report_level = args[:expression_report_level] if args.key?(:expression_report_level)
          @function_mocks = args[:function_mocks] if args.key?(:function_mocks)
          @path_encoding = args[:path_encoding] if args.key?(:path_encoding)
          @request = args[:request] if args.key?(:request)
          @resource = args[:resource] if args.key?(:resource)
        end
      end
      
      # Test result message containing the state of the test as well as a description
      # and source position for test failures.
      class TestResult
        include Google::Apis::Core::Hashable
      
        # 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"]```
        # Corresponds to the JSON property `debugMessages`
        # @return [Array<String>]
        attr_accessor :debug_messages
      
        # Position in the `Source` content including its line, column number, and an
        # index of the `File` in the `Source` message. Used for debug purposes.
        # Corresponds to the JSON property `errorPosition`
        # @return [Google::Apis::FirebaserulesV1::SourcePosition]
        attr_accessor :error_position
      
        # The mapping from expression in the ruleset AST to the values they were
        # evaluated to. Partially-nested to mirror AST structure. Note that this field
        # is actually tracking expressions and not permission statements in contrast to
        # the "visited_expressions" field above. Literal expressions are omitted.
        # Corresponds to the JSON property `expressionReports`
        # @return [Array<Google::Apis::FirebaserulesV1::ExpressionReport>]
        attr_accessor :expression_reports
      
        # 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`.
        # Corresponds to the JSON property `functionCalls`
        # @return [Array<Google::Apis::FirebaserulesV1::FunctionCall>]
        attr_accessor :function_calls
      
        # State of the test.
        # Corresponds to the JSON property `state`
        # @return [String]
        attr_accessor :state
      
        # 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: ` ```
        # For a detailed report of the intermediate evaluation states, see the `
        # expression_reports` field
        # Corresponds to the JSON property `visitedExpressions`
        # @return [Array<Google::Apis::FirebaserulesV1::VisitedExpression>]
        attr_accessor :visited_expressions
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @debug_messages = args[:debug_messages] if args.key?(:debug_messages)
          @error_position = args[:error_position] if args.key?(:error_position)
          @expression_reports = args[:expression_reports] if args.key?(:expression_reports)
          @function_calls = args[:function_calls] if args.key?(:function_calls)
          @state = args[:state] if args.key?(:state)
          @visited_expressions = args[:visited_expressions] if args.key?(:visited_expressions)
        end
      end
      
      # The request for FirebaseRulesService.TestRuleset.
      class TestRulesetRequest
        include Google::Apis::Core::Hashable
      
        # `Source` is one or more `File` messages comprising a logical set of rules.
        # Corresponds to the JSON property `source`
        # @return [Google::Apis::FirebaserulesV1::Source]
        attr_accessor :source
      
        # `TestSuite` is a collection of `TestCase` instances that validate the logical
        # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a
        # `TestRuleset` invocation or as part of a `Release` object as a pre-release
        # check.
        # Corresponds to the JSON property `testSuite`
        # @return [Google::Apis::FirebaserulesV1::TestSuite]
        attr_accessor :test_suite
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @source = args[:source] if args.key?(:source)
          @test_suite = args[:test_suite] if args.key?(:test_suite)
        end
      end
      
      # The response for FirebaseRulesService.TestRuleset.
      class TestRulesetResponse
        include Google::Apis::Core::Hashable
      
        # Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR`
        # severity will prevent tests from executing.
        # Corresponds to the JSON property `issues`
        # @return [Array<Google::Apis::FirebaserulesV1::Issue>]
        attr_accessor :issues
      
        # 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`.
        # Corresponds to the JSON property `testResults`
        # @return [Array<Google::Apis::FirebaserulesV1::TestResult>]
        attr_accessor :test_results
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @issues = args[:issues] if args.key?(:issues)
          @test_results = args[:test_results] if args.key?(:test_results)
        end
      end
      
      # `TestSuite` is a collection of `TestCase` instances that validate the logical
      # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a
      # `TestRuleset` invocation or as part of a `Release` object as a pre-release
      # check.
      class TestSuite
        include Google::Apis::Core::Hashable
      
        # Collection of test cases associated with the `TestSuite`.
        # Corresponds to the JSON property `testCases`
        # @return [Array<Google::Apis::FirebaserulesV1::TestCase>]
        attr_accessor :test_cases
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @test_cases = args[:test_cases] if args.key?(:test_cases)
        end
      end
      
      # The request for FirebaseRulesService.UpdateReleasePatch.
      class UpdateReleaseRequest
        include Google::Apis::Core::Hashable
      
        # `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`.
        # Corresponds to the JSON property `release`
        # @return [Google::Apis::FirebaserulesV1::Release]
        attr_accessor :release
      
        # Specifies which fields to update.
        # Corresponds to the JSON property `updateMask`
        # @return [String]
        attr_accessor :update_mask
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @release = args[:release] if args.key?(:release)
          @update_mask = args[:update_mask] if args.key?(:update_mask)
        end
      end
      
      # Tuple for how many times an Expression was evaluated to a particular
      # ExpressionValue.
      class ValueCount
        include Google::Apis::Core::Hashable
      
        # The amount of times that expression returned.
        # Corresponds to the JSON property `count`
        # @return [Fixnum]
        attr_accessor :count
      
        # The return value of the expression
        # Corresponds to the JSON property `value`
        # @return [Object]
        attr_accessor :value
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @count = args[:count] if args.key?(:count)
          @value = args[:value] if args.key?(:value)
        end
      end
      
      # Store the position and access outcome for an expression visited in rules.
      class VisitedExpression
        include Google::Apis::Core::Hashable
      
        # Position in the `Source` content including its line, column number, and an
        # index of the `File` in the `Source` message. Used for debug purposes.
        # Corresponds to the JSON property `sourcePosition`
        # @return [Google::Apis::FirebaserulesV1::SourcePosition]
        attr_accessor :source_position
      
        # The evaluated value for the visited expression, e.g. true/false
        # Corresponds to the JSON property `value`
        # @return [Object]
        attr_accessor :value
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @source_position = args[:source_position] if args.key?(:source_position)
          @value = args[:value] if args.key?(:value)
        end
      end
    end
  end
end