google-apis-firebaserules_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-firebaserules_v1.rb +15 -0
- data/lib/google/apis/firebaserules_v1.rb +43 -0
- data/lib/google/apis/firebaserules_v1/classes.rb +825 -0
- data/lib/google/apis/firebaserules_v1/gem_version.rb +28 -0
- data/lib/google/apis/firebaserules_v1/representations.rb +405 -0
- data/lib/google/apis/firebaserules_v1/service.rb +493 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 95e4f2d49eb504e9047b4a5a207578498f2c258e781da04971c539ac3a15e92f
|
4
|
+
data.tar.gz: 44fe7ac1af18d11a44f20d42c0cfb3b80e5a53c80de39f43ea31bb4714191eb2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ff8f2b17327269326bf55bd6e2285e6d5d84b6044e2b17de3d9061ff2b1660d9d4741565665856c39cb1b2285348b74043b4448fcba89a6cd394663a05be1cea
|
7
|
+
data.tar.gz: a51c20ce33f63c701c21b8ee4b43b26f5fb5f1b71bd5c2a42483889182aee2754c16f5cae50c9bd07efb0601a137ae177f8feabb604d56b78a8e10ab4d39313d
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-firebaserules_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/firebaserules_v1/*.rb
|
9
|
+
lib/google/apis/firebaserules_v1.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1 of the Firebase Rules API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Firebase Rules API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/firebaserules.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-firebaserules_v1', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-firebaserules_v1
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/firebaserules_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::FirebaserulesV1::FirebaseRulesService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Firebaserules service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Firebase Rules API, see the {Google::Apis::FirebaserulesV1::FirebaseRulesService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-firebaserules_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://firebase.google.com/docs/storage/security) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "google/apis/firebaserules_v1"
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/firebaserules_v1/service.rb'
|
16
|
+
require 'google/apis/firebaserules_v1/classes.rb'
|
17
|
+
require 'google/apis/firebaserules_v1/representations.rb'
|
18
|
+
require 'google/apis/firebaserules_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Firebase Rules API
|
23
|
+
#
|
24
|
+
# Creates and manages rules that determine when a Firebase Rules-enabled service
|
25
|
+
# should permit a request.
|
26
|
+
#
|
27
|
+
# @see https://firebase.google.com/docs/storage/security
|
28
|
+
module FirebaserulesV1
|
29
|
+
# Version of the Firebase Rules API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
|
33
|
+
# View and manage your data across Google Cloud Platform services
|
34
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
35
|
+
|
36
|
+
# View and administer all your Firebase data and settings
|
37
|
+
AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase'
|
38
|
+
|
39
|
+
# View all your Firebase data and settings
|
40
|
+
AUTH_FIREBASE_READONLY = 'https://www.googleapis.com/auth/firebase.readonly'
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,825 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'date'
|
16
|
+
require 'google/apis/core/base_service'
|
17
|
+
require 'google/apis/core/json_representation'
|
18
|
+
require 'google/apis/core/hashable'
|
19
|
+
require 'google/apis/errors'
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Apis
|
23
|
+
module FirebaserulesV1
|
24
|
+
|
25
|
+
# Arg matchers for the mock function.
|
26
|
+
class Arg
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
30
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
31
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
32
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
33
|
+
# `Empty` is empty JSON object ````.
|
34
|
+
# Corresponds to the JSON property `anyValue`
|
35
|
+
# @return [Google::Apis::FirebaserulesV1::Empty]
|
36
|
+
attr_accessor :any_value
|
37
|
+
|
38
|
+
# Argument exactly matches value provided.
|
39
|
+
# Corresponds to the JSON property `exactValue`
|
40
|
+
# @return [Object]
|
41
|
+
attr_accessor :exact_value
|
42
|
+
|
43
|
+
def initialize(**args)
|
44
|
+
update!(**args)
|
45
|
+
end
|
46
|
+
|
47
|
+
# Update properties of this object
|
48
|
+
def update!(**args)
|
49
|
+
@any_value = args[:any_value] if args.key?(:any_value)
|
50
|
+
@exact_value = args[:exact_value] if args.key?(:exact_value)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
55
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
56
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
57
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
58
|
+
# `Empty` is empty JSON object ````.
|
59
|
+
class Empty
|
60
|
+
include Google::Apis::Core::Hashable
|
61
|
+
|
62
|
+
def initialize(**args)
|
63
|
+
update!(**args)
|
64
|
+
end
|
65
|
+
|
66
|
+
# Update properties of this object
|
67
|
+
def update!(**args)
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
# Describes where in a file an expression is found and what it was evaluated to
|
72
|
+
# over the course of its use.
|
73
|
+
class ExpressionReport
|
74
|
+
include Google::Apis::Core::Hashable
|
75
|
+
|
76
|
+
# Subexpressions
|
77
|
+
# Corresponds to the JSON property `children`
|
78
|
+
# @return [Array<Google::Apis::FirebaserulesV1::ExpressionReport>]
|
79
|
+
attr_accessor :children
|
80
|
+
|
81
|
+
# Position in the `Source` content including its line, column number, and an
|
82
|
+
# index of the `File` in the `Source` message. Used for debug purposes.
|
83
|
+
# Corresponds to the JSON property `sourcePosition`
|
84
|
+
# @return [Google::Apis::FirebaserulesV1::SourcePosition]
|
85
|
+
attr_accessor :source_position
|
86
|
+
|
87
|
+
# Values that this expression evaluated to when encountered.
|
88
|
+
# Corresponds to the JSON property `values`
|
89
|
+
# @return [Array<Google::Apis::FirebaserulesV1::ValueCount>]
|
90
|
+
attr_accessor :values
|
91
|
+
|
92
|
+
def initialize(**args)
|
93
|
+
update!(**args)
|
94
|
+
end
|
95
|
+
|
96
|
+
# Update properties of this object
|
97
|
+
def update!(**args)
|
98
|
+
@children = args[:children] if args.key?(:children)
|
99
|
+
@source_position = args[:source_position] if args.key?(:source_position)
|
100
|
+
@values = args[:values] if args.key?(:values)
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
# `File` containing source content.
|
105
|
+
class File
|
106
|
+
include Google::Apis::Core::Hashable
|
107
|
+
|
108
|
+
# Textual Content.
|
109
|
+
# Corresponds to the JSON property `content`
|
110
|
+
# @return [String]
|
111
|
+
attr_accessor :content
|
112
|
+
|
113
|
+
# Fingerprint (e.g. github sha) associated with the `File`.
|
114
|
+
# Corresponds to the JSON property `fingerprint`
|
115
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
116
|
+
# @return [String]
|
117
|
+
attr_accessor :fingerprint
|
118
|
+
|
119
|
+
# File name.
|
120
|
+
# Corresponds to the JSON property `name`
|
121
|
+
# @return [String]
|
122
|
+
attr_accessor :name
|
123
|
+
|
124
|
+
def initialize(**args)
|
125
|
+
update!(**args)
|
126
|
+
end
|
127
|
+
|
128
|
+
# Update properties of this object
|
129
|
+
def update!(**args)
|
130
|
+
@content = args[:content] if args.key?(:content)
|
131
|
+
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
|
132
|
+
@name = args[:name] if args.key?(:name)
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
# Represents a service-defined function call that was invoked during test
|
137
|
+
# execution.
|
138
|
+
class FunctionCall
|
139
|
+
include Google::Apis::Core::Hashable
|
140
|
+
|
141
|
+
# The arguments that were provided to the function.
|
142
|
+
# Corresponds to the JSON property `args`
|
143
|
+
# @return [Array<Object>]
|
144
|
+
attr_accessor :args
|
145
|
+
|
146
|
+
# Name of the function invoked.
|
147
|
+
# Corresponds to the JSON property `function`
|
148
|
+
# @return [String]
|
149
|
+
attr_accessor :function
|
150
|
+
|
151
|
+
def initialize(**args)
|
152
|
+
update!(**args)
|
153
|
+
end
|
154
|
+
|
155
|
+
# Update properties of this object
|
156
|
+
def update!(**args)
|
157
|
+
@args = args[:args] if args.key?(:args)
|
158
|
+
@function = args[:function] if args.key?(:function)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
162
|
+
# Mock function definition. Mocks must refer to a function declared by the
|
163
|
+
# target service. The type of the function args and result will be inferred at
|
164
|
+
# test time. If either the arg or result values are not compatible with function
|
165
|
+
# type declaration, the request will be considered invalid. More than one `
|
166
|
+
# FunctionMock` may be provided for a given function name so long as the `Arg`
|
167
|
+
# matchers are distinct. There may be only one function for a given overload
|
168
|
+
# where all `Arg` values are `Arg.any_value`.
|
169
|
+
class FunctionMock
|
170
|
+
include Google::Apis::Core::Hashable
|
171
|
+
|
172
|
+
# The list of `Arg` values to match. The order in which the arguments are
|
173
|
+
# provided is the order in which they must appear in the function invocation.
|
174
|
+
# Corresponds to the JSON property `args`
|
175
|
+
# @return [Array<Google::Apis::FirebaserulesV1::Arg>]
|
176
|
+
attr_accessor :args
|
177
|
+
|
178
|
+
# The name of the function. The function name must match one provided by a
|
179
|
+
# service declaration.
|
180
|
+
# Corresponds to the JSON property `function`
|
181
|
+
# @return [String]
|
182
|
+
attr_accessor :function
|
183
|
+
|
184
|
+
# Possible result values from the function mock invocation.
|
185
|
+
# Corresponds to the JSON property `result`
|
186
|
+
# @return [Google::Apis::FirebaserulesV1::Result]
|
187
|
+
attr_accessor :result
|
188
|
+
|
189
|
+
def initialize(**args)
|
190
|
+
update!(**args)
|
191
|
+
end
|
192
|
+
|
193
|
+
# Update properties of this object
|
194
|
+
def update!(**args)
|
195
|
+
@args = args[:args] if args.key?(:args)
|
196
|
+
@function = args[:function] if args.key?(:function)
|
197
|
+
@result = args[:result] if args.key?(:result)
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
# The response for FirebaseRulesService.GetReleaseExecutable
|
202
|
+
class GetReleaseExecutableResponse
|
203
|
+
include Google::Apis::Core::Hashable
|
204
|
+
|
205
|
+
# Executable view of the `Ruleset` referenced by the `Release`.
|
206
|
+
# Corresponds to the JSON property `executable`
|
207
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
208
|
+
# @return [String]
|
209
|
+
attr_accessor :executable
|
210
|
+
|
211
|
+
# The Rules runtime version of the executable.
|
212
|
+
# Corresponds to the JSON property `executableVersion`
|
213
|
+
# @return [String]
|
214
|
+
attr_accessor :executable_version
|
215
|
+
|
216
|
+
# `Language` used to generate the executable bytes.
|
217
|
+
# Corresponds to the JSON property `language`
|
218
|
+
# @return [String]
|
219
|
+
attr_accessor :language
|
220
|
+
|
221
|
+
# `Ruleset` name associated with the `Release` executable.
|
222
|
+
# Corresponds to the JSON property `rulesetName`
|
223
|
+
# @return [String]
|
224
|
+
attr_accessor :ruleset_name
|
225
|
+
|
226
|
+
# Optional, indicates the freshness of the result. The response is guaranteed to
|
227
|
+
# be the latest within an interval up to the sync_time (inclusive).
|
228
|
+
# Corresponds to the JSON property `syncTime`
|
229
|
+
# @return [String]
|
230
|
+
attr_accessor :sync_time
|
231
|
+
|
232
|
+
# Timestamp for the most recent `Release.update_time`.
|
233
|
+
# Corresponds to the JSON property `updateTime`
|
234
|
+
# @return [String]
|
235
|
+
attr_accessor :update_time
|
236
|
+
|
237
|
+
def initialize(**args)
|
238
|
+
update!(**args)
|
239
|
+
end
|
240
|
+
|
241
|
+
# Update properties of this object
|
242
|
+
def update!(**args)
|
243
|
+
@executable = args[:executable] if args.key?(:executable)
|
244
|
+
@executable_version = args[:executable_version] if args.key?(:executable_version)
|
245
|
+
@language = args[:language] if args.key?(:language)
|
246
|
+
@ruleset_name = args[:ruleset_name] if args.key?(:ruleset_name)
|
247
|
+
@sync_time = args[:sync_time] if args.key?(:sync_time)
|
248
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
249
|
+
end
|
250
|
+
end
|
251
|
+
|
252
|
+
# Issues include warnings, errors, and deprecation notices.
|
253
|
+
class Issue
|
254
|
+
include Google::Apis::Core::Hashable
|
255
|
+
|
256
|
+
# Short error description.
|
257
|
+
# Corresponds to the JSON property `description`
|
258
|
+
# @return [String]
|
259
|
+
attr_accessor :description
|
260
|
+
|
261
|
+
# The severity of the issue.
|
262
|
+
# Corresponds to the JSON property `severity`
|
263
|
+
# @return [String]
|
264
|
+
attr_accessor :severity
|
265
|
+
|
266
|
+
# Position in the `Source` content including its line, column number, and an
|
267
|
+
# index of the `File` in the `Source` message. Used for debug purposes.
|
268
|
+
# Corresponds to the JSON property `sourcePosition`
|
269
|
+
# @return [Google::Apis::FirebaserulesV1::SourcePosition]
|
270
|
+
attr_accessor :source_position
|
271
|
+
|
272
|
+
def initialize(**args)
|
273
|
+
update!(**args)
|
274
|
+
end
|
275
|
+
|
276
|
+
# Update properties of this object
|
277
|
+
def update!(**args)
|
278
|
+
@description = args[:description] if args.key?(:description)
|
279
|
+
@severity = args[:severity] if args.key?(:severity)
|
280
|
+
@source_position = args[:source_position] if args.key?(:source_position)
|
281
|
+
end
|
282
|
+
end
|
283
|
+
|
284
|
+
# The response for FirebaseRulesService.ListReleases.
|
285
|
+
class ListReleasesResponse
|
286
|
+
include Google::Apis::Core::Hashable
|
287
|
+
|
288
|
+
# The pagination token to retrieve the next page of results. If the value is
|
289
|
+
# empty, no further results remain.
|
290
|
+
# Corresponds to the JSON property `nextPageToken`
|
291
|
+
# @return [String]
|
292
|
+
attr_accessor :next_page_token
|
293
|
+
|
294
|
+
# List of `Release` instances.
|
295
|
+
# Corresponds to the JSON property `releases`
|
296
|
+
# @return [Array<Google::Apis::FirebaserulesV1::Release>]
|
297
|
+
attr_accessor :releases
|
298
|
+
|
299
|
+
def initialize(**args)
|
300
|
+
update!(**args)
|
301
|
+
end
|
302
|
+
|
303
|
+
# Update properties of this object
|
304
|
+
def update!(**args)
|
305
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
306
|
+
@releases = args[:releases] if args.key?(:releases)
|
307
|
+
end
|
308
|
+
end
|
309
|
+
|
310
|
+
# The response for FirebaseRulesService.ListRulesets.
|
311
|
+
class ListRulesetsResponse
|
312
|
+
include Google::Apis::Core::Hashable
|
313
|
+
|
314
|
+
# The pagination token to retrieve the next page of results. If the value is
|
315
|
+
# empty, no further results remain.
|
316
|
+
# Corresponds to the JSON property `nextPageToken`
|
317
|
+
# @return [String]
|
318
|
+
attr_accessor :next_page_token
|
319
|
+
|
320
|
+
# List of `Ruleset` instances.
|
321
|
+
# Corresponds to the JSON property `rulesets`
|
322
|
+
# @return [Array<Google::Apis::FirebaserulesV1::Ruleset>]
|
323
|
+
attr_accessor :rulesets
|
324
|
+
|
325
|
+
def initialize(**args)
|
326
|
+
update!(**args)
|
327
|
+
end
|
328
|
+
|
329
|
+
# Update properties of this object
|
330
|
+
def update!(**args)
|
331
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
332
|
+
@rulesets = args[:rulesets] if args.key?(:rulesets)
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
336
|
+
# Metadata for a Ruleset.
|
337
|
+
class Metadata
|
338
|
+
include Google::Apis::Core::Hashable
|
339
|
+
|
340
|
+
# Services that this ruleset has declarations for (e.g., "cloud.firestore").
|
341
|
+
# There may be 0+ of these.
|
342
|
+
# Corresponds to the JSON property `services`
|
343
|
+
# @return [Array<String>]
|
344
|
+
attr_accessor :services
|
345
|
+
|
346
|
+
def initialize(**args)
|
347
|
+
update!(**args)
|
348
|
+
end
|
349
|
+
|
350
|
+
# Update properties of this object
|
351
|
+
def update!(**args)
|
352
|
+
@services = args[:services] if args.key?(:services)
|
353
|
+
end
|
354
|
+
end
|
355
|
+
|
356
|
+
# `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `
|
357
|
+
# Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
|
358
|
+
class Release
|
359
|
+
include Google::Apis::Core::Hashable
|
360
|
+
|
361
|
+
# Time the release was created. Output only.
|
362
|
+
# Corresponds to the JSON property `createTime`
|
363
|
+
# @return [String]
|
364
|
+
attr_accessor :create_time
|
365
|
+
|
366
|
+
# Resource name for the `Release`. `Release` names may be structured `app1/prod/
|
367
|
+
# v2` or flat `app1_prod_v2` which affords developers a great deal of
|
368
|
+
# flexibility in mapping the name to the style that best fits their existing
|
369
|
+
# development practices. For example, a name could refer to an environment, an
|
370
|
+
# app, a version, or some combination of three. In the table below, for the
|
371
|
+
# project name `projects/foo`, the following relative release paths show how
|
372
|
+
# flat and structured names might be chosen to match a desired development /
|
373
|
+
# deployment strategy. Use Case | Flat Name | Structured Name -------------|-----
|
374
|
+
# ----------------|---------------- Environments | releases/qa | releases/qa
|
375
|
+
# Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa |
|
376
|
+
# releases/app1/v2/qa The delimiter between the release name path elements can
|
377
|
+
# be almost anything and it should work equally well with the release name list
|
378
|
+
# filter, but in many ways the structured paths provide a clearer picture of the
|
379
|
+
# relationship between `Release` instances. Format: `projects/`project_id`/
|
380
|
+
# releases/`release_id``
|
381
|
+
# Corresponds to the JSON property `name`
|
382
|
+
# @return [String]
|
383
|
+
attr_accessor :name
|
384
|
+
|
385
|
+
# Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must exist
|
386
|
+
# the `Release` to be created.
|
387
|
+
# Corresponds to the JSON property `rulesetName`
|
388
|
+
# @return [String]
|
389
|
+
attr_accessor :ruleset_name
|
390
|
+
|
391
|
+
# Time the release was updated. Output only.
|
392
|
+
# Corresponds to the JSON property `updateTime`
|
393
|
+
# @return [String]
|
394
|
+
attr_accessor :update_time
|
395
|
+
|
396
|
+
def initialize(**args)
|
397
|
+
update!(**args)
|
398
|
+
end
|
399
|
+
|
400
|
+
# Update properties of this object
|
401
|
+
def update!(**args)
|
402
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
403
|
+
@name = args[:name] if args.key?(:name)
|
404
|
+
@ruleset_name = args[:ruleset_name] if args.key?(:ruleset_name)
|
405
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
406
|
+
end
|
407
|
+
end
|
408
|
+
|
409
|
+
# Possible result values from the function mock invocation.
|
410
|
+
class Result
|
411
|
+
include Google::Apis::Core::Hashable
|
412
|
+
|
413
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
414
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
415
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
416
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
417
|
+
# `Empty` is empty JSON object ````.
|
418
|
+
# Corresponds to the JSON property `undefined`
|
419
|
+
# @return [Google::Apis::FirebaserulesV1::Empty]
|
420
|
+
attr_accessor :undefined
|
421
|
+
|
422
|
+
# The result is an actual value. The type of the value must match that of the
|
423
|
+
# type declared by the service.
|
424
|
+
# Corresponds to the JSON property `value`
|
425
|
+
# @return [Object]
|
426
|
+
attr_accessor :value
|
427
|
+
|
428
|
+
def initialize(**args)
|
429
|
+
update!(**args)
|
430
|
+
end
|
431
|
+
|
432
|
+
# Update properties of this object
|
433
|
+
def update!(**args)
|
434
|
+
@undefined = args[:undefined] if args.key?(:undefined)
|
435
|
+
@value = args[:value] if args.key?(:value)
|
436
|
+
end
|
437
|
+
end
|
438
|
+
|
439
|
+
# `Ruleset` is an immutable copy of `Source` with a globally unique identifier
|
440
|
+
# and a creation time.
|
441
|
+
class Ruleset
|
442
|
+
include Google::Apis::Core::Hashable
|
443
|
+
|
444
|
+
# Time the `Ruleset` was created. Output only.
|
445
|
+
# Corresponds to the JSON property `createTime`
|
446
|
+
# @return [String]
|
447
|
+
attr_accessor :create_time
|
448
|
+
|
449
|
+
# Metadata for a Ruleset.
|
450
|
+
# Corresponds to the JSON property `metadata`
|
451
|
+
# @return [Google::Apis::FirebaserulesV1::Metadata]
|
452
|
+
attr_accessor :metadata
|
453
|
+
|
454
|
+
# Name of the `Ruleset`. The ruleset_id is auto generated by the service. Format:
|
455
|
+
# `projects/`project_id`/rulesets/`ruleset_id`` Output only.
|
456
|
+
# Corresponds to the JSON property `name`
|
457
|
+
# @return [String]
|
458
|
+
attr_accessor :name
|
459
|
+
|
460
|
+
# `Source` is one or more `File` messages comprising a logical set of rules.
|
461
|
+
# Corresponds to the JSON property `source`
|
462
|
+
# @return [Google::Apis::FirebaserulesV1::Source]
|
463
|
+
attr_accessor :source
|
464
|
+
|
465
|
+
def initialize(**args)
|
466
|
+
update!(**args)
|
467
|
+
end
|
468
|
+
|
469
|
+
# Update properties of this object
|
470
|
+
def update!(**args)
|
471
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
472
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
473
|
+
@name = args[:name] if args.key?(:name)
|
474
|
+
@source = args[:source] if args.key?(:source)
|
475
|
+
end
|
476
|
+
end
|
477
|
+
|
478
|
+
# `Source` is one or more `File` messages comprising a logical set of rules.
|
479
|
+
class Source
|
480
|
+
include Google::Apis::Core::Hashable
|
481
|
+
|
482
|
+
# `File` set constituting the `Source` bundle.
|
483
|
+
# Corresponds to the JSON property `files`
|
484
|
+
# @return [Array<Google::Apis::FirebaserulesV1::File>]
|
485
|
+
attr_accessor :files
|
486
|
+
|
487
|
+
def initialize(**args)
|
488
|
+
update!(**args)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Update properties of this object
|
492
|
+
def update!(**args)
|
493
|
+
@files = args[:files] if args.key?(:files)
|
494
|
+
end
|
495
|
+
end
|
496
|
+
|
497
|
+
# Position in the `Source` content including its line, column number, and an
|
498
|
+
# index of the `File` in the `Source` message. Used for debug purposes.
|
499
|
+
class SourcePosition
|
500
|
+
include Google::Apis::Core::Hashable
|
501
|
+
|
502
|
+
# First column on the source line associated with the source fragment.
|
503
|
+
# Corresponds to the JSON property `column`
|
504
|
+
# @return [Fixnum]
|
505
|
+
attr_accessor :column
|
506
|
+
|
507
|
+
# Start position relative to the beginning of the file.
|
508
|
+
# Corresponds to the JSON property `currentOffset`
|
509
|
+
# @return [Fixnum]
|
510
|
+
attr_accessor :current_offset
|
511
|
+
|
512
|
+
# End position relative to the beginning of the file.
|
513
|
+
# Corresponds to the JSON property `endOffset`
|
514
|
+
# @return [Fixnum]
|
515
|
+
attr_accessor :end_offset
|
516
|
+
|
517
|
+
# Name of the `File`.
|
518
|
+
# Corresponds to the JSON property `fileName`
|
519
|
+
# @return [String]
|
520
|
+
attr_accessor :file_name
|
521
|
+
|
522
|
+
# Line number of the source fragment. 1-based.
|
523
|
+
# Corresponds to the JSON property `line`
|
524
|
+
# @return [Fixnum]
|
525
|
+
attr_accessor :line
|
526
|
+
|
527
|
+
def initialize(**args)
|
528
|
+
update!(**args)
|
529
|
+
end
|
530
|
+
|
531
|
+
# Update properties of this object
|
532
|
+
def update!(**args)
|
533
|
+
@column = args[:column] if args.key?(:column)
|
534
|
+
@current_offset = args[:current_offset] if args.key?(:current_offset)
|
535
|
+
@end_offset = args[:end_offset] if args.key?(:end_offset)
|
536
|
+
@file_name = args[:file_name] if args.key?(:file_name)
|
537
|
+
@line = args[:line] if args.key?(:line)
|
538
|
+
end
|
539
|
+
end
|
540
|
+
|
541
|
+
# `TestCase` messages provide the request context and an expectation as to
|
542
|
+
# whether the given context will be allowed or denied. Test cases may specify
|
543
|
+
# the `request`, `resource`, and `function_mocks` to mock a function call to a
|
544
|
+
# service-provided function. The `request` object represents context present at
|
545
|
+
# request-time. The `resource` is the value of the target resource as it appears
|
546
|
+
# in persistent storage before the request is executed.
|
547
|
+
class TestCase
|
548
|
+
include Google::Apis::Core::Hashable
|
549
|
+
|
550
|
+
# Test expectation.
|
551
|
+
# Corresponds to the JSON property `expectation`
|
552
|
+
# @return [String]
|
553
|
+
attr_accessor :expectation
|
554
|
+
|
555
|
+
# Specifies what should be included in the response.
|
556
|
+
# Corresponds to the JSON property `expressionReportLevel`
|
557
|
+
# @return [String]
|
558
|
+
attr_accessor :expression_report_level
|
559
|
+
|
560
|
+
# Optional function mocks for service-defined functions. If not set, any service
|
561
|
+
# defined function is expected to return an error, which may or may not
|
562
|
+
# influence the test outcome.
|
563
|
+
# Corresponds to the JSON property `functionMocks`
|
564
|
+
# @return [Array<Google::Apis::FirebaserulesV1::FunctionMock>]
|
565
|
+
attr_accessor :function_mocks
|
566
|
+
|
567
|
+
# Specifies whether paths (such as request.path) are encoded and how.
|
568
|
+
# Corresponds to the JSON property `pathEncoding`
|
569
|
+
# @return [String]
|
570
|
+
attr_accessor :path_encoding
|
571
|
+
|
572
|
+
# Request context. The exact format of the request context is service-dependent.
|
573
|
+
# See the appropriate service documentation for information about the supported
|
574
|
+
# fields and types on the request. Minimally, all services support the following
|
575
|
+
# fields and types: Request field | Type ---------------|----------------- auth.
|
576
|
+
# uid | `string` auth.token | `map` headers | `map` method | `string` params | `
|
577
|
+
# map` path | `string` time | `google.protobuf.Timestamp` If the request value
|
578
|
+
# is not well-formed for the service, the request will be rejected as an invalid
|
579
|
+
# argument.
|
580
|
+
# Corresponds to the JSON property `request`
|
581
|
+
# @return [Object]
|
582
|
+
attr_accessor :request
|
583
|
+
|
584
|
+
# Optional resource value as it appears in persistent storage before the request
|
585
|
+
# is fulfilled. The resource type depends on the `request.path` value.
|
586
|
+
# Corresponds to the JSON property `resource`
|
587
|
+
# @return [Object]
|
588
|
+
attr_accessor :resource
|
589
|
+
|
590
|
+
def initialize(**args)
|
591
|
+
update!(**args)
|
592
|
+
end
|
593
|
+
|
594
|
+
# Update properties of this object
|
595
|
+
def update!(**args)
|
596
|
+
@expectation = args[:expectation] if args.key?(:expectation)
|
597
|
+
@expression_report_level = args[:expression_report_level] if args.key?(:expression_report_level)
|
598
|
+
@function_mocks = args[:function_mocks] if args.key?(:function_mocks)
|
599
|
+
@path_encoding = args[:path_encoding] if args.key?(:path_encoding)
|
600
|
+
@request = args[:request] if args.key?(:request)
|
601
|
+
@resource = args[:resource] if args.key?(:resource)
|
602
|
+
end
|
603
|
+
end
|
604
|
+
|
605
|
+
# Test result message containing the state of the test as well as a description
|
606
|
+
# and source position for test failures.
|
607
|
+
class TestResult
|
608
|
+
include Google::Apis::Core::Hashable
|
609
|
+
|
610
|
+
# Debug messages related to test execution issues encountered during evaluation.
|
611
|
+
# Debug messages may be related to too many or too few invocations of function
|
612
|
+
# mocks or to runtime errors that occur during evaluation. For example: ```
|
613
|
+
# Unable to read variable [name: "resource"]```
|
614
|
+
# Corresponds to the JSON property `debugMessages`
|
615
|
+
# @return [Array<String>]
|
616
|
+
attr_accessor :debug_messages
|
617
|
+
|
618
|
+
# Position in the `Source` content including its line, column number, and an
|
619
|
+
# index of the `File` in the `Source` message. Used for debug purposes.
|
620
|
+
# Corresponds to the JSON property `errorPosition`
|
621
|
+
# @return [Google::Apis::FirebaserulesV1::SourcePosition]
|
622
|
+
attr_accessor :error_position
|
623
|
+
|
624
|
+
# The mapping from expression in the ruleset AST to the values they were
|
625
|
+
# evaluated to. Partially-nested to mirror AST structure. Note that this field
|
626
|
+
# is actually tracking expressions and not permission statements in contrast to
|
627
|
+
# the "visited_expressions" field above. Literal expressions are omitted.
|
628
|
+
# Corresponds to the JSON property `expressionReports`
|
629
|
+
# @return [Array<Google::Apis::FirebaserulesV1::ExpressionReport>]
|
630
|
+
attr_accessor :expression_reports
|
631
|
+
|
632
|
+
# The set of function calls made to service-defined methods. Function calls are
|
633
|
+
# included in the order in which they are encountered during evaluation, are
|
634
|
+
# provided for both mocked and unmocked functions, and included on the response
|
635
|
+
# regardless of the test `state`.
|
636
|
+
# Corresponds to the JSON property `functionCalls`
|
637
|
+
# @return [Array<Google::Apis::FirebaserulesV1::FunctionCall>]
|
638
|
+
attr_accessor :function_calls
|
639
|
+
|
640
|
+
# State of the test.
|
641
|
+
# Corresponds to the JSON property `state`
|
642
|
+
# @return [String]
|
643
|
+
attr_accessor :state
|
644
|
+
|
645
|
+
# The set of visited permission expressions for a given test. This returns the
|
646
|
+
# positions and evaluation results of all visited permission expressions which
|
647
|
+
# were relevant to the test case, e.g. ``` match /path ` allow read if: ` ```
|
648
|
+
# For a detailed report of the intermediate evaluation states, see the `
|
649
|
+
# expression_reports` field
|
650
|
+
# Corresponds to the JSON property `visitedExpressions`
|
651
|
+
# @return [Array<Google::Apis::FirebaserulesV1::VisitedExpression>]
|
652
|
+
attr_accessor :visited_expressions
|
653
|
+
|
654
|
+
def initialize(**args)
|
655
|
+
update!(**args)
|
656
|
+
end
|
657
|
+
|
658
|
+
# Update properties of this object
|
659
|
+
def update!(**args)
|
660
|
+
@debug_messages = args[:debug_messages] if args.key?(:debug_messages)
|
661
|
+
@error_position = args[:error_position] if args.key?(:error_position)
|
662
|
+
@expression_reports = args[:expression_reports] if args.key?(:expression_reports)
|
663
|
+
@function_calls = args[:function_calls] if args.key?(:function_calls)
|
664
|
+
@state = args[:state] if args.key?(:state)
|
665
|
+
@visited_expressions = args[:visited_expressions] if args.key?(:visited_expressions)
|
666
|
+
end
|
667
|
+
end
|
668
|
+
|
669
|
+
# The request for FirebaseRulesService.TestRuleset.
|
670
|
+
class TestRulesetRequest
|
671
|
+
include Google::Apis::Core::Hashable
|
672
|
+
|
673
|
+
# `Source` is one or more `File` messages comprising a logical set of rules.
|
674
|
+
# Corresponds to the JSON property `source`
|
675
|
+
# @return [Google::Apis::FirebaserulesV1::Source]
|
676
|
+
attr_accessor :source
|
677
|
+
|
678
|
+
# `TestSuite` is a collection of `TestCase` instances that validate the logical
|
679
|
+
# correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a
|
680
|
+
# `TestRuleset` invocation or as part of a `Release` object as a pre-release
|
681
|
+
# check.
|
682
|
+
# Corresponds to the JSON property `testSuite`
|
683
|
+
# @return [Google::Apis::FirebaserulesV1::TestSuite]
|
684
|
+
attr_accessor :test_suite
|
685
|
+
|
686
|
+
def initialize(**args)
|
687
|
+
update!(**args)
|
688
|
+
end
|
689
|
+
|
690
|
+
# Update properties of this object
|
691
|
+
def update!(**args)
|
692
|
+
@source = args[:source] if args.key?(:source)
|
693
|
+
@test_suite = args[:test_suite] if args.key?(:test_suite)
|
694
|
+
end
|
695
|
+
end
|
696
|
+
|
697
|
+
# The response for FirebaseRulesService.TestRuleset.
|
698
|
+
class TestRulesetResponse
|
699
|
+
include Google::Apis::Core::Hashable
|
700
|
+
|
701
|
+
# Syntactic and semantic `Source` issues of varying severity. Issues of `ERROR`
|
702
|
+
# severity will prevent tests from executing.
|
703
|
+
# Corresponds to the JSON property `issues`
|
704
|
+
# @return [Array<Google::Apis::FirebaserulesV1::Issue>]
|
705
|
+
attr_accessor :issues
|
706
|
+
|
707
|
+
# The set of test results given the test cases in the `TestSuite`. The results
|
708
|
+
# will appear in the same order as the test cases appear in the `TestSuite`.
|
709
|
+
# Corresponds to the JSON property `testResults`
|
710
|
+
# @return [Array<Google::Apis::FirebaserulesV1::TestResult>]
|
711
|
+
attr_accessor :test_results
|
712
|
+
|
713
|
+
def initialize(**args)
|
714
|
+
update!(**args)
|
715
|
+
end
|
716
|
+
|
717
|
+
# Update properties of this object
|
718
|
+
def update!(**args)
|
719
|
+
@issues = args[:issues] if args.key?(:issues)
|
720
|
+
@test_results = args[:test_results] if args.key?(:test_results)
|
721
|
+
end
|
722
|
+
end
|
723
|
+
|
724
|
+
# `TestSuite` is a collection of `TestCase` instances that validate the logical
|
725
|
+
# correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within a
|
726
|
+
# `TestRuleset` invocation or as part of a `Release` object as a pre-release
|
727
|
+
# check.
|
728
|
+
class TestSuite
|
729
|
+
include Google::Apis::Core::Hashable
|
730
|
+
|
731
|
+
# Collection of test cases associated with the `TestSuite`.
|
732
|
+
# Corresponds to the JSON property `testCases`
|
733
|
+
# @return [Array<Google::Apis::FirebaserulesV1::TestCase>]
|
734
|
+
attr_accessor :test_cases
|
735
|
+
|
736
|
+
def initialize(**args)
|
737
|
+
update!(**args)
|
738
|
+
end
|
739
|
+
|
740
|
+
# Update properties of this object
|
741
|
+
def update!(**args)
|
742
|
+
@test_cases = args[:test_cases] if args.key?(:test_cases)
|
743
|
+
end
|
744
|
+
end
|
745
|
+
|
746
|
+
# The request for FirebaseRulesService.UpdateReleasePatch.
|
747
|
+
class UpdateReleaseRequest
|
748
|
+
include Google::Apis::Core::Hashable
|
749
|
+
|
750
|
+
# `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a `
|
751
|
+
# Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.
|
752
|
+
# Corresponds to the JSON property `release`
|
753
|
+
# @return [Google::Apis::FirebaserulesV1::Release]
|
754
|
+
attr_accessor :release
|
755
|
+
|
756
|
+
# Specifies which fields to update.
|
757
|
+
# Corresponds to the JSON property `updateMask`
|
758
|
+
# @return [String]
|
759
|
+
attr_accessor :update_mask
|
760
|
+
|
761
|
+
def initialize(**args)
|
762
|
+
update!(**args)
|
763
|
+
end
|
764
|
+
|
765
|
+
# Update properties of this object
|
766
|
+
def update!(**args)
|
767
|
+
@release = args[:release] if args.key?(:release)
|
768
|
+
@update_mask = args[:update_mask] if args.key?(:update_mask)
|
769
|
+
end
|
770
|
+
end
|
771
|
+
|
772
|
+
# Tuple for how many times an Expression was evaluated to a particular
|
773
|
+
# ExpressionValue.
|
774
|
+
class ValueCount
|
775
|
+
include Google::Apis::Core::Hashable
|
776
|
+
|
777
|
+
# The amount of times that expression returned.
|
778
|
+
# Corresponds to the JSON property `count`
|
779
|
+
# @return [Fixnum]
|
780
|
+
attr_accessor :count
|
781
|
+
|
782
|
+
# The return value of the expression
|
783
|
+
# Corresponds to the JSON property `value`
|
784
|
+
# @return [Object]
|
785
|
+
attr_accessor :value
|
786
|
+
|
787
|
+
def initialize(**args)
|
788
|
+
update!(**args)
|
789
|
+
end
|
790
|
+
|
791
|
+
# Update properties of this object
|
792
|
+
def update!(**args)
|
793
|
+
@count = args[:count] if args.key?(:count)
|
794
|
+
@value = args[:value] if args.key?(:value)
|
795
|
+
end
|
796
|
+
end
|
797
|
+
|
798
|
+
# Store the position and access outcome for an expression visited in rules.
|
799
|
+
class VisitedExpression
|
800
|
+
include Google::Apis::Core::Hashable
|
801
|
+
|
802
|
+
# Position in the `Source` content including its line, column number, and an
|
803
|
+
# index of the `File` in the `Source` message. Used for debug purposes.
|
804
|
+
# Corresponds to the JSON property `sourcePosition`
|
805
|
+
# @return [Google::Apis::FirebaserulesV1::SourcePosition]
|
806
|
+
attr_accessor :source_position
|
807
|
+
|
808
|
+
# The evaluated value for the visited expression, e.g. true/false
|
809
|
+
# Corresponds to the JSON property `value`
|
810
|
+
# @return [Object]
|
811
|
+
attr_accessor :value
|
812
|
+
|
813
|
+
def initialize(**args)
|
814
|
+
update!(**args)
|
815
|
+
end
|
816
|
+
|
817
|
+
# Update properties of this object
|
818
|
+
def update!(**args)
|
819
|
+
@source_position = args[:source_position] if args.key?(:source_position)
|
820
|
+
@value = args[:value] if args.key?(:value)
|
821
|
+
end
|
822
|
+
end
|
823
|
+
end
|
824
|
+
end
|
825
|
+
end
|