google-apis-firebase_v1beta1 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-firebase_v1beta1.rb +15 -0
- data/lib/google/apis/firebase_v1beta1.rb +46 -0
- data/lib/google/apis/firebase_v1beta1/classes.rb +1302 -0
- data/lib/google/apis/firebase_v1beta1/gem_version.rb +28 -0
- data/lib/google/apis/firebase_v1beta1/representations.rb +535 -0
- data/lib/google/apis/firebase_v1beta1/service.rb +1386 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: de12d20338ebab824269de5e4147b444d329079be4a02c6fb482cdc5accffa6c
|
4
|
+
data.tar.gz: d835b2e9180c8432111819874fea27fa2f6e6ea5dfd030ac7a40a2f8e707b9cc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b4f39ccb45e6fe6eaea575a3a0bc403083409c22b978840482bbfcb92c25d7a36838c9d56e8f022eaadb3486dc11f5335d5be080623bd92c42b8aef5b7391b28
|
7
|
+
data.tar.gz: b77955bc999e7c3fdf0066f64cf3dcdedbd46142bee62253483cd3aff91ca06d6b549d0fea21d6674e2561385ef7058fc36c2f62f5a7b631865bb017199f24b0
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-firebase_v1beta1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/firebase_v1beta1/*.rb
|
9
|
+
lib/google/apis/firebase_v1beta1.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 V1beta1 of the Firebase Management API
|
2
|
+
|
3
|
+
This is a simple client library for version V1beta1 of the Firebase Management 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/firebase.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-firebase_v1beta1', '~> 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-firebase_v1beta1
|
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/firebase_v1beta1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::FirebaseV1beta1::FirebaseManagementService.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 Firebase service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Firebase Management API, see the {Google::Apis::FirebaseV1beta1::FirebaseManagementService 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-firebase_v1beta1`, 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) 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/firebase_v1beta1"
|
@@ -0,0 +1,46 @@
|
|
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/firebase_v1beta1/service.rb'
|
16
|
+
require 'google/apis/firebase_v1beta1/classes.rb'
|
17
|
+
require 'google/apis/firebase_v1beta1/representations.rb'
|
18
|
+
require 'google/apis/firebase_v1beta1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Firebase Management API
|
23
|
+
#
|
24
|
+
# The Firebase Management API enables programmatic setup and management of
|
25
|
+
# Firebase projects, including a project's Firebase resources and Firebase apps.
|
26
|
+
#
|
27
|
+
# @see https://firebase.google.com
|
28
|
+
module FirebaseV1beta1
|
29
|
+
# Version of the Firebase Management API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1beta1'
|
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 your data across Google Cloud Platform services
|
37
|
+
AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only'
|
38
|
+
|
39
|
+
# View and administer all your Firebase data and settings
|
40
|
+
AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase'
|
41
|
+
|
42
|
+
# View all your Firebase data and settings
|
43
|
+
AUTH_FIREBASE_READONLY = 'https://www.googleapis.com/auth/firebase.readonly'
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,1302 @@
|
|
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 FirebaseV1beta1
|
24
|
+
|
25
|
+
# All fields are required.
|
26
|
+
class AddFirebaseRequest
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Deprecated. Instead, to set a Project's default GCP resource location, call [`
|
30
|
+
# FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add
|
31
|
+
# Firebase resources to the GCP `Project`. The ID of the Project's default GCP
|
32
|
+
# resource location. The location must be one of the available [GCP resource
|
33
|
+
# locations](https://firebase.google.com/docs/projects/locations).
|
34
|
+
# Corresponds to the JSON property `locationId`
|
35
|
+
# @return [String]
|
36
|
+
attr_accessor :location_id
|
37
|
+
|
38
|
+
# Deprecated. Instead, to link a Project with a Google Analytics account, call [`
|
39
|
+
# AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add
|
40
|
+
# Firebase resources to the GCP `Project`. The region code (CLDR) that the
|
41
|
+
# account will use for Google Analytics data For example: US, GB, or DE In Java,
|
42
|
+
# use `com.google.i18n.identifiers.RegionCode`.
|
43
|
+
# Corresponds to the JSON property `regionCode`
|
44
|
+
# @return [String]
|
45
|
+
attr_accessor :region_code
|
46
|
+
|
47
|
+
# Deprecated. Instead, to link a Project with a Google Analytics account, call [`
|
48
|
+
# AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add
|
49
|
+
# Firebase resources to the GCP `Project`. The time zone that the account will
|
50
|
+
# use for Google Analytics data. For example: America/Los_Angeles or Africa/
|
51
|
+
# Abidjan
|
52
|
+
# Corresponds to the JSON property `timeZone`
|
53
|
+
# @return [String]
|
54
|
+
attr_accessor :time_zone
|
55
|
+
|
56
|
+
def initialize(**args)
|
57
|
+
update!(**args)
|
58
|
+
end
|
59
|
+
|
60
|
+
# Update properties of this object
|
61
|
+
def update!(**args)
|
62
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
63
|
+
@region_code = args[:region_code] if args.key?(:region_code)
|
64
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
#
|
69
|
+
class AddGoogleAnalyticsRequest
|
70
|
+
include Google::Apis::Core::Hashable
|
71
|
+
|
72
|
+
# The ID for the existing [Google Analytics account](http://www.google.com/
|
73
|
+
# analytics/) that you want to link with the `FirebaseProject`. Specifying this
|
74
|
+
# field will provision a new Google Analytics property in your Google Analytics
|
75
|
+
# account and associate the new property with the `FirebaseProject`.
|
76
|
+
# Corresponds to the JSON property `analyticsAccountId`
|
77
|
+
# @return [String]
|
78
|
+
attr_accessor :analytics_account_id
|
79
|
+
|
80
|
+
# The ID for the existing Google Analytics property that you want to associate
|
81
|
+
# with the `FirebaseProject`.
|
82
|
+
# Corresponds to the JSON property `analyticsPropertyId`
|
83
|
+
# @return [String]
|
84
|
+
attr_accessor :analytics_property_id
|
85
|
+
|
86
|
+
def initialize(**args)
|
87
|
+
update!(**args)
|
88
|
+
end
|
89
|
+
|
90
|
+
# Update properties of this object
|
91
|
+
def update!(**args)
|
92
|
+
@analytics_account_id = args[:analytics_account_id] if args.key?(:analytics_account_id)
|
93
|
+
@analytics_property_id = args[:analytics_property_id] if args.key?(:analytics_property_id)
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
#
|
98
|
+
class AdminSdkConfig
|
99
|
+
include Google::Apis::Core::Hashable
|
100
|
+
|
101
|
+
# The default Firebase Realtime Database URL.
|
102
|
+
# Corresponds to the JSON property `databaseURL`
|
103
|
+
# @return [String]
|
104
|
+
attr_accessor :database_url
|
105
|
+
|
106
|
+
# The ID of the Project's default GCP resource location. The location is one of
|
107
|
+
# the available [GCP resource locations](https://firebase.google.com/docs/
|
108
|
+
# projects/locations). This field is omitted if the default GCP resource
|
109
|
+
# location has not been finalized yet. To set a Project's default GCP resource
|
110
|
+
# location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/
|
111
|
+
# finalize) after you add Firebase resources to the Project.
|
112
|
+
# Corresponds to the JSON property `locationId`
|
113
|
+
# @return [String]
|
114
|
+
attr_accessor :location_id
|
115
|
+
|
116
|
+
# Immutable. A user-assigned unique identifier for the `FirebaseProject`. This
|
117
|
+
# identifier may appear in URLs or names for some Firebase resources associated
|
118
|
+
# with the Project, but it should generally be treated as a convenience alias to
|
119
|
+
# reference the Project.
|
120
|
+
# Corresponds to the JSON property `projectId`
|
121
|
+
# @return [String]
|
122
|
+
attr_accessor :project_id
|
123
|
+
|
124
|
+
# The default Cloud Storage for Firebase storage bucket name.
|
125
|
+
# Corresponds to the JSON property `storageBucket`
|
126
|
+
# @return [String]
|
127
|
+
attr_accessor :storage_bucket
|
128
|
+
|
129
|
+
def initialize(**args)
|
130
|
+
update!(**args)
|
131
|
+
end
|
132
|
+
|
133
|
+
# Update properties of this object
|
134
|
+
def update!(**args)
|
135
|
+
@database_url = args[:database_url] if args.key?(:database_url)
|
136
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
137
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
138
|
+
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
#
|
143
|
+
class AnalyticsDetails
|
144
|
+
include Google::Apis::Core::Hashable
|
145
|
+
|
146
|
+
# Details of a Google Analytics property
|
147
|
+
# Corresponds to the JSON property `analyticsProperty`
|
148
|
+
# @return [Google::Apis::FirebaseV1beta1::AnalyticsProperty]
|
149
|
+
attr_accessor :analytics_property
|
150
|
+
|
151
|
+
# - For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each
|
152
|
+
# Firebase App in the specified `FirebaseProject`. Each `app` and `streamId`
|
153
|
+
# appears only once. - For `WebApps`: a map of `app` to `streamId` and `
|
154
|
+
# measurementId` for each `WebApp` in the specified `FirebaseProject`. Each `app`
|
155
|
+
# , `streamId`, and `measurementId` appears only once.
|
156
|
+
# Corresponds to the JSON property `streamMappings`
|
157
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::StreamMapping>]
|
158
|
+
attr_accessor :stream_mappings
|
159
|
+
|
160
|
+
def initialize(**args)
|
161
|
+
update!(**args)
|
162
|
+
end
|
163
|
+
|
164
|
+
# Update properties of this object
|
165
|
+
def update!(**args)
|
166
|
+
@analytics_property = args[:analytics_property] if args.key?(:analytics_property)
|
167
|
+
@stream_mappings = args[:stream_mappings] if args.key?(:stream_mappings)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
|
171
|
+
# Details of a Google Analytics property
|
172
|
+
class AnalyticsProperty
|
173
|
+
include Google::Apis::Core::Hashable
|
174
|
+
|
175
|
+
# The display name of the Google Analytics property associated with the
|
176
|
+
# specified `FirebaseProject`.
|
177
|
+
# Corresponds to the JSON property `displayName`
|
178
|
+
# @return [String]
|
179
|
+
attr_accessor :display_name
|
180
|
+
|
181
|
+
# The globally unique, Google-assigned identifier of the Google Analytics
|
182
|
+
# property associated with the specified `FirebaseProject`. If you called [`
|
183
|
+
# AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link the `
|
184
|
+
# FirebaseProject` with a Google Analytics account, the value in this `id` field
|
185
|
+
# is the same as the ID of the property either specified or provisioned with
|
186
|
+
# that call to `AddGoogleAnalytics`.
|
187
|
+
# Corresponds to the JSON property `id`
|
188
|
+
# @return [String]
|
189
|
+
attr_accessor :id
|
190
|
+
|
191
|
+
def initialize(**args)
|
192
|
+
update!(**args)
|
193
|
+
end
|
194
|
+
|
195
|
+
# Update properties of this object
|
196
|
+
def update!(**args)
|
197
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
198
|
+
@id = args[:id] if args.key?(:id)
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
# Details of a Firebase App for Android.
|
203
|
+
class AndroidApp
|
204
|
+
include Google::Apis::Core::Hashable
|
205
|
+
|
206
|
+
# Immutable. The globally unique, Firebase-assigned identifier for the `
|
207
|
+
# AndroidApp`. This identifier should be treated as an opaque token, as the data
|
208
|
+
# format is not specified.
|
209
|
+
# Corresponds to the JSON property `appId`
|
210
|
+
# @return [String]
|
211
|
+
attr_accessor :app_id
|
212
|
+
|
213
|
+
# The user-assigned display name for the `AndroidApp`.
|
214
|
+
# Corresponds to the JSON property `displayName`
|
215
|
+
# @return [String]
|
216
|
+
attr_accessor :display_name
|
217
|
+
|
218
|
+
# The resource name of the AndroidApp, in the format: projects/
|
219
|
+
# PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'
|
220
|
+
# s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(
|
221
|
+
# recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.
|
222
|
+
# project_id). Learn more about using project identifiers in Google's [AIP 2510
|
223
|
+
# standard](https://google.aip.dev/cloud/2510). Note that the value for
|
224
|
+
# PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the
|
225
|
+
# globally unique, Firebase-assigned identifier for the App (see [`appId`](../
|
226
|
+
# projects.androidApps#AndroidApp.FIELDS.app_id)).
|
227
|
+
# Corresponds to the JSON property `name`
|
228
|
+
# @return [String]
|
229
|
+
attr_accessor :name
|
230
|
+
|
231
|
+
# Immutable. The canonical package name of the Android app as would appear in
|
232
|
+
# the Google Play Developer Console.
|
233
|
+
# Corresponds to the JSON property `packageName`
|
234
|
+
# @return [String]
|
235
|
+
attr_accessor :package_name
|
236
|
+
|
237
|
+
# Immutable. A user-assigned unique identifier of the parent FirebaseProject for
|
238
|
+
# the `AndroidApp`.
|
239
|
+
# Corresponds to the JSON property `projectId`
|
240
|
+
# @return [String]
|
241
|
+
attr_accessor :project_id
|
242
|
+
|
243
|
+
def initialize(**args)
|
244
|
+
update!(**args)
|
245
|
+
end
|
246
|
+
|
247
|
+
# Update properties of this object
|
248
|
+
def update!(**args)
|
249
|
+
@app_id = args[:app_id] if args.key?(:app_id)
|
250
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
251
|
+
@name = args[:name] if args.key?(:name)
|
252
|
+
@package_name = args[:package_name] if args.key?(:package_name)
|
253
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
254
|
+
end
|
255
|
+
end
|
256
|
+
|
257
|
+
# Configuration metadata of a single Firebase App for Android.
|
258
|
+
class AndroidAppConfig
|
259
|
+
include Google::Apis::Core::Hashable
|
260
|
+
|
261
|
+
# The contents of the JSON configuration file.
|
262
|
+
# Corresponds to the JSON property `configFileContents`
|
263
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
264
|
+
# @return [String]
|
265
|
+
attr_accessor :config_file_contents
|
266
|
+
|
267
|
+
# The filename that the configuration artifact for the `AndroidApp` is typically
|
268
|
+
# saved as. For example: `google-services.json`
|
269
|
+
# Corresponds to the JSON property `configFilename`
|
270
|
+
# @return [String]
|
271
|
+
attr_accessor :config_filename
|
272
|
+
|
273
|
+
def initialize(**args)
|
274
|
+
update!(**args)
|
275
|
+
end
|
276
|
+
|
277
|
+
# Update properties of this object
|
278
|
+
def update!(**args)
|
279
|
+
@config_file_contents = args[:config_file_contents] if args.key?(:config_file_contents)
|
280
|
+
@config_filename = args[:config_filename] if args.key?(:config_filename)
|
281
|
+
end
|
282
|
+
end
|
283
|
+
|
284
|
+
# The default resources associated with the Project.
|
285
|
+
class DefaultResources
|
286
|
+
include Google::Apis::Core::Hashable
|
287
|
+
|
288
|
+
# The default Firebase Hosting site name, in the format: PROJECT_ID Though rare,
|
289
|
+
# your `projectId` might already be used as the name for an existing Hosting
|
290
|
+
# site in another project (learn more about creating non-default, [additional
|
291
|
+
# sites](https://firebase.google.com/docs/hosting/multisites)). In these cases,
|
292
|
+
# your `projectId` is appended with a hyphen then five alphanumeric characters
|
293
|
+
# to create your default Hosting site name. For example, if your `projectId` is `
|
294
|
+
# myproject123`, your default Hosting site name might be: `myproject123-a5c16`
|
295
|
+
# Corresponds to the JSON property `hostingSite`
|
296
|
+
# @return [String]
|
297
|
+
attr_accessor :hosting_site
|
298
|
+
|
299
|
+
# The ID of the Project's default GCP resource location. The location is one of
|
300
|
+
# the available [GCP resource locations](https://firebase.google.com/docs/
|
301
|
+
# projects/locations). This field is omitted if the default GCP resource
|
302
|
+
# location has not been finalized yet. To set a Project's default GCP resource
|
303
|
+
# location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/
|
304
|
+
# finalize) after you add Firebase resources to the Project.
|
305
|
+
# Corresponds to the JSON property `locationId`
|
306
|
+
# @return [String]
|
307
|
+
attr_accessor :location_id
|
308
|
+
|
309
|
+
# The default Firebase Realtime Database instance name, in the format:
|
310
|
+
# PROJECT_ID Though rare, your `projectId` might already be used as the name for
|
311
|
+
# an existing Realtime Database instance in another project (learn more about [
|
312
|
+
# database sharding](https://firebase.google.com/docs/database/usage/sharding)).
|
313
|
+
# In these cases, your `projectId` is appended with a hyphen then five
|
314
|
+
# alphanumeric characters to create your default Realtime Database instance name.
|
315
|
+
# For example, if your `projectId` is `myproject123`, your default database
|
316
|
+
# instance name might be: `myproject123-a5c16`
|
317
|
+
# Corresponds to the JSON property `realtimeDatabaseInstance`
|
318
|
+
# @return [String]
|
319
|
+
attr_accessor :realtime_database_instance
|
320
|
+
|
321
|
+
# The default Cloud Storage for Firebase storage bucket, in the format:
|
322
|
+
# PROJECT_ID.appspot.com
|
323
|
+
# Corresponds to the JSON property `storageBucket`
|
324
|
+
# @return [String]
|
325
|
+
attr_accessor :storage_bucket
|
326
|
+
|
327
|
+
def initialize(**args)
|
328
|
+
update!(**args)
|
329
|
+
end
|
330
|
+
|
331
|
+
# Update properties of this object
|
332
|
+
def update!(**args)
|
333
|
+
@hosting_site = args[:hosting_site] if args.key?(:hosting_site)
|
334
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
335
|
+
@realtime_database_instance = args[:realtime_database_instance] if args.key?(:realtime_database_instance)
|
336
|
+
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
|
337
|
+
end
|
338
|
+
end
|
339
|
+
|
340
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
341
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
342
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
343
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
344
|
+
# `Empty` is empty JSON object ````.
|
345
|
+
class Empty
|
346
|
+
include Google::Apis::Core::Hashable
|
347
|
+
|
348
|
+
def initialize(**args)
|
349
|
+
update!(**args)
|
350
|
+
end
|
351
|
+
|
352
|
+
# Update properties of this object
|
353
|
+
def update!(**args)
|
354
|
+
end
|
355
|
+
end
|
356
|
+
|
357
|
+
#
|
358
|
+
class FinalizeDefaultLocationRequest
|
359
|
+
include Google::Apis::Core::Hashable
|
360
|
+
|
361
|
+
# The ID of the Project's default GCP resource location. The location must be
|
362
|
+
# one of the available [GCP resource locations](https://firebase.google.com/docs/
|
363
|
+
# projects/locations).
|
364
|
+
# Corresponds to the JSON property `locationId`
|
365
|
+
# @return [String]
|
366
|
+
attr_accessor :location_id
|
367
|
+
|
368
|
+
def initialize(**args)
|
369
|
+
update!(**args)
|
370
|
+
end
|
371
|
+
|
372
|
+
# Update properties of this object
|
373
|
+
def update!(**args)
|
374
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
375
|
+
end
|
376
|
+
end
|
377
|
+
|
378
|
+
# A high-level summary of an App.
|
379
|
+
class FirebaseAppInfo
|
380
|
+
include Google::Apis::Core::Hashable
|
381
|
+
|
382
|
+
# Output only. Immutable. The globally unique, Firebase-assigned identifier for
|
383
|
+
# the `WebApp`. This identifier should be treated as an opaque token, as the
|
384
|
+
# data format is not specified.
|
385
|
+
# Corresponds to the JSON property `appId`
|
386
|
+
# @return [String]
|
387
|
+
attr_accessor :app_id
|
388
|
+
|
389
|
+
# The user-assigned display name of the Firebase App.
|
390
|
+
# Corresponds to the JSON property `displayName`
|
391
|
+
# @return [String]
|
392
|
+
attr_accessor :display_name
|
393
|
+
|
394
|
+
# The resource name of the Firebase App, in the format: projects/PROJECT_ID /
|
395
|
+
# iosApps/APP_ID or projects/PROJECT_ID/androidApps/APP_ID or projects/
|
396
|
+
# PROJECT_ID/webApps/APP_ID
|
397
|
+
# Corresponds to the JSON property `name`
|
398
|
+
# @return [String]
|
399
|
+
attr_accessor :name
|
400
|
+
|
401
|
+
# Output only. Immutable. The platform-specific identifier of the App. *Note:*
|
402
|
+
# For most use cases, use `appId`, which is the canonical, globally unique
|
403
|
+
# identifier for referencing an App. This string is derived from a native
|
404
|
+
# identifier for each platform: `packageName` for an `AndroidApp`, `bundleId`
|
405
|
+
# for an `IosApp`, and `webId` for a `WebApp`. Its contents should be treated as
|
406
|
+
# opaque, as the native identifier format may change as platforms evolve. This
|
407
|
+
# string is only unique within a `FirebaseProject` and its associated Apps.
|
408
|
+
# Corresponds to the JSON property `namespace`
|
409
|
+
# @return [String]
|
410
|
+
attr_accessor :namespace
|
411
|
+
|
412
|
+
# The platform of the Firebase App.
|
413
|
+
# Corresponds to the JSON property `platform`
|
414
|
+
# @return [String]
|
415
|
+
attr_accessor :platform
|
416
|
+
|
417
|
+
def initialize(**args)
|
418
|
+
update!(**args)
|
419
|
+
end
|
420
|
+
|
421
|
+
# Update properties of this object
|
422
|
+
def update!(**args)
|
423
|
+
@app_id = args[:app_id] if args.key?(:app_id)
|
424
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
425
|
+
@name = args[:name] if args.key?(:name)
|
426
|
+
@namespace = args[:namespace] if args.key?(:namespace)
|
427
|
+
@platform = args[:platform] if args.key?(:platform)
|
428
|
+
end
|
429
|
+
end
|
430
|
+
|
431
|
+
# A `FirebaseProject` is the top-level Firebase entity. It is the container for
|
432
|
+
# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime
|
433
|
+
# Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and
|
434
|
+
# Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by
|
435
|
+
# calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud.
|
436
|
+
# google.com/resource-manager/reference/rest/v1/projects). This adds Firebase
|
437
|
+
# resources to the existing GCP `Project`. Since a FirebaseProject is actually
|
438
|
+
# also a GCP `Project`, a `FirebaseProject` has the same underlying GCP
|
439
|
+
# identifiers (`projectNumber` and `projectId`). This allows for easy interop
|
440
|
+
# with Google APIs.
|
441
|
+
class FirebaseProject
|
442
|
+
include Google::Apis::Core::Hashable
|
443
|
+
|
444
|
+
# The user-assigned display name of the Project.
|
445
|
+
# Corresponds to the JSON property `displayName`
|
446
|
+
# @return [String]
|
447
|
+
attr_accessor :display_name
|
448
|
+
|
449
|
+
# The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER
|
450
|
+
# PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects#
|
451
|
+
# FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`]
|
452
|
+
# (../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
453
|
+
# project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/
|
454
|
+
# cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body
|
455
|
+
# will be the `ProjectId`.
|
456
|
+
# Corresponds to the JSON property `name`
|
457
|
+
# @return [String]
|
458
|
+
attr_accessor :name
|
459
|
+
|
460
|
+
# Immutable. A user-assigned unique identifier for the Project. This identifier
|
461
|
+
# may appear in URLs or names for some Firebase resources associated with the
|
462
|
+
# Project, but it should generally be treated as a convenience alias to
|
463
|
+
# reference the Project.
|
464
|
+
# Corresponds to the JSON property `projectId`
|
465
|
+
# @return [String]
|
466
|
+
attr_accessor :project_id
|
467
|
+
|
468
|
+
# Immutable. The globally unique, Google-assigned canonical identifier for the
|
469
|
+
# Project. Use this identifier when configuring integrations and/or making API
|
470
|
+
# calls to Firebase or third-party services.
|
471
|
+
# Corresponds to the JSON property `projectNumber`
|
472
|
+
# @return [Fixnum]
|
473
|
+
attr_accessor :project_number
|
474
|
+
|
475
|
+
# The default resources associated with the Project.
|
476
|
+
# Corresponds to the JSON property `resources`
|
477
|
+
# @return [Google::Apis::FirebaseV1beta1::DefaultResources]
|
478
|
+
attr_accessor :resources
|
479
|
+
|
480
|
+
# Output only. The lifecycle state of the Project. Updates to the state must be
|
481
|
+
# performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and
|
482
|
+
# com.google.cloudresourcemanager.v1.Projects.UndeleteProject
|
483
|
+
# Corresponds to the JSON property `state`
|
484
|
+
# @return [String]
|
485
|
+
attr_accessor :state
|
486
|
+
|
487
|
+
def initialize(**args)
|
488
|
+
update!(**args)
|
489
|
+
end
|
490
|
+
|
491
|
+
# Update properties of this object
|
492
|
+
def update!(**args)
|
493
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
494
|
+
@name = args[:name] if args.key?(:name)
|
495
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
496
|
+
@project_number = args[:project_number] if args.key?(:project_number)
|
497
|
+
@resources = args[:resources] if args.key?(:resources)
|
498
|
+
@state = args[:state] if args.key?(:state)
|
499
|
+
end
|
500
|
+
end
|
501
|
+
|
502
|
+
# Details of a Firebase App for iOS.
|
503
|
+
class IosApp
|
504
|
+
include Google::Apis::Core::Hashable
|
505
|
+
|
506
|
+
# Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`.
|
507
|
+
# This identifier should be treated as an opaque token, as the data format is
|
508
|
+
# not specified.
|
509
|
+
# Corresponds to the JSON property `appId`
|
510
|
+
# @return [String]
|
511
|
+
attr_accessor :app_id
|
512
|
+
|
513
|
+
# The automatically generated Apple ID assigned to the iOS app by Apple in the
|
514
|
+
# iOS App Store.
|
515
|
+
# Corresponds to the JSON property `appStoreId`
|
516
|
+
# @return [String]
|
517
|
+
attr_accessor :app_store_id
|
518
|
+
|
519
|
+
# Immutable. The canonical bundle ID of the iOS app as it would appear in the
|
520
|
+
# iOS AppStore.
|
521
|
+
# Corresponds to the JSON property `bundleId`
|
522
|
+
# @return [String]
|
523
|
+
attr_accessor :bundle_id
|
524
|
+
|
525
|
+
# The user-assigned display name for the `IosApp`.
|
526
|
+
# Corresponds to the JSON property `displayName`
|
527
|
+
# @return [String]
|
528
|
+
attr_accessor :display_name
|
529
|
+
|
530
|
+
# The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /
|
531
|
+
# iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../
|
532
|
+
# projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`
|
533
|
+
# ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
534
|
+
# using project identifiers in Google's [AIP 2510 standard](https://google.aip.
|
535
|
+
# dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response
|
536
|
+
# body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned
|
537
|
+
# identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)
|
538
|
+
# ).
|
539
|
+
# Corresponds to the JSON property `name`
|
540
|
+
# @return [String]
|
541
|
+
attr_accessor :name
|
542
|
+
|
543
|
+
# Immutable. A user-assigned unique identifier of the parent FirebaseProject for
|
544
|
+
# the `IosApp`.
|
545
|
+
# Corresponds to the JSON property `projectId`
|
546
|
+
# @return [String]
|
547
|
+
attr_accessor :project_id
|
548
|
+
|
549
|
+
def initialize(**args)
|
550
|
+
update!(**args)
|
551
|
+
end
|
552
|
+
|
553
|
+
# Update properties of this object
|
554
|
+
def update!(**args)
|
555
|
+
@app_id = args[:app_id] if args.key?(:app_id)
|
556
|
+
@app_store_id = args[:app_store_id] if args.key?(:app_store_id)
|
557
|
+
@bundle_id = args[:bundle_id] if args.key?(:bundle_id)
|
558
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
559
|
+
@name = args[:name] if args.key?(:name)
|
560
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
561
|
+
end
|
562
|
+
end
|
563
|
+
|
564
|
+
# Configuration metadata of a single Firebase App for iOS.
|
565
|
+
class IosAppConfig
|
566
|
+
include Google::Apis::Core::Hashable
|
567
|
+
|
568
|
+
# The content of the XML configuration file.
|
569
|
+
# Corresponds to the JSON property `configFileContents`
|
570
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
571
|
+
# @return [String]
|
572
|
+
attr_accessor :config_file_contents
|
573
|
+
|
574
|
+
# The filename that the configuration artifact for the `IosApp` is typically
|
575
|
+
# saved as. For example: `GoogleService-Info.plist`
|
576
|
+
# Corresponds to the JSON property `configFilename`
|
577
|
+
# @return [String]
|
578
|
+
attr_accessor :config_filename
|
579
|
+
|
580
|
+
def initialize(**args)
|
581
|
+
update!(**args)
|
582
|
+
end
|
583
|
+
|
584
|
+
# Update properties of this object
|
585
|
+
def update!(**args)
|
586
|
+
@config_file_contents = args[:config_file_contents] if args.key?(:config_file_contents)
|
587
|
+
@config_filename = args[:config_filename] if args.key?(:config_filename)
|
588
|
+
end
|
589
|
+
end
|
590
|
+
|
591
|
+
#
|
592
|
+
class ListAndroidAppsResponse
|
593
|
+
include Google::Apis::Core::Hashable
|
594
|
+
|
595
|
+
# List of each `AndroidApp` associated with the specified `FirebaseProject`.
|
596
|
+
# Corresponds to the JSON property `apps`
|
597
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::AndroidApp>]
|
598
|
+
attr_accessor :apps
|
599
|
+
|
600
|
+
# If the result list is too large to fit in a single response, then a token is
|
601
|
+
# returned. If the string is empty, then this response is the last page of
|
602
|
+
# results. This token can be used in a subsequent call to `ListAndroidApps` to
|
603
|
+
# find the next group of Apps. Page tokens are short-lived and should not be
|
604
|
+
# persisted.
|
605
|
+
# Corresponds to the JSON property `nextPageToken`
|
606
|
+
# @return [String]
|
607
|
+
attr_accessor :next_page_token
|
608
|
+
|
609
|
+
def initialize(**args)
|
610
|
+
update!(**args)
|
611
|
+
end
|
612
|
+
|
613
|
+
# Update properties of this object
|
614
|
+
def update!(**args)
|
615
|
+
@apps = args[:apps] if args.key?(:apps)
|
616
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
617
|
+
end
|
618
|
+
end
|
619
|
+
|
620
|
+
#
|
621
|
+
class ListAvailableLocationsResponse
|
622
|
+
include Google::Apis::Core::Hashable
|
623
|
+
|
624
|
+
# One page of results from a call to `ListAvailableLocations`.
|
625
|
+
# Corresponds to the JSON property `locations`
|
626
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::Location>]
|
627
|
+
attr_accessor :locations
|
628
|
+
|
629
|
+
# If the result list is too large to fit in a single response, then a token is
|
630
|
+
# returned. If the string is empty, then this response is the last page of
|
631
|
+
# results and all available locations have been listed. This token can be used
|
632
|
+
# in a subsequent call to `ListAvailableLocations` to find more locations. Page
|
633
|
+
# tokens are short-lived and should not be persisted.
|
634
|
+
# Corresponds to the JSON property `nextPageToken`
|
635
|
+
# @return [String]
|
636
|
+
attr_accessor :next_page_token
|
637
|
+
|
638
|
+
def initialize(**args)
|
639
|
+
update!(**args)
|
640
|
+
end
|
641
|
+
|
642
|
+
# Update properties of this object
|
643
|
+
def update!(**args)
|
644
|
+
@locations = args[:locations] if args.key?(:locations)
|
645
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
646
|
+
end
|
647
|
+
end
|
648
|
+
|
649
|
+
#
|
650
|
+
class ListAvailableProjectsResponse
|
651
|
+
include Google::Apis::Core::Hashable
|
652
|
+
|
653
|
+
# If the result list is too large to fit in a single response, then a token is
|
654
|
+
# returned. If the string is empty, then this response is the last page of
|
655
|
+
# results. This token can be used in a subsequent calls to `
|
656
|
+
# ListAvailableProjects` to find the next group of Projects. Page tokens are
|
657
|
+
# short-lived and should not be persisted.
|
658
|
+
# Corresponds to the JSON property `nextPageToken`
|
659
|
+
# @return [String]
|
660
|
+
attr_accessor :next_page_token
|
661
|
+
|
662
|
+
# The list of GCP `Projects` which can have Firebase resources added to them.
|
663
|
+
# Corresponds to the JSON property `projectInfo`
|
664
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::ProjectInfo>]
|
665
|
+
attr_accessor :project_info
|
666
|
+
|
667
|
+
def initialize(**args)
|
668
|
+
update!(**args)
|
669
|
+
end
|
670
|
+
|
671
|
+
# Update properties of this object
|
672
|
+
def update!(**args)
|
673
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
674
|
+
@project_info = args[:project_info] if args.key?(:project_info)
|
675
|
+
end
|
676
|
+
end
|
677
|
+
|
678
|
+
#
|
679
|
+
class ListFirebaseProjectsResponse
|
680
|
+
include Google::Apis::Core::Hashable
|
681
|
+
|
682
|
+
# If the result list is too large to fit in a single response, then a token is
|
683
|
+
# returned. If the string is empty, then this response is the last page of
|
684
|
+
# results. This token can be used in a subsequent calls to `ListFirebaseProjects`
|
685
|
+
# to find the next group of Projects. Page tokens are short-lived and should
|
686
|
+
# not be persisted.
|
687
|
+
# Corresponds to the JSON property `nextPageToken`
|
688
|
+
# @return [String]
|
689
|
+
attr_accessor :next_page_token
|
690
|
+
|
691
|
+
# One page of the list of Projects that are accessible to the caller.
|
692
|
+
# Corresponds to the JSON property `results`
|
693
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::FirebaseProject>]
|
694
|
+
attr_accessor :results
|
695
|
+
|
696
|
+
def initialize(**args)
|
697
|
+
update!(**args)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Update properties of this object
|
701
|
+
def update!(**args)
|
702
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
703
|
+
@results = args[:results] if args.key?(:results)
|
704
|
+
end
|
705
|
+
end
|
706
|
+
|
707
|
+
#
|
708
|
+
class ListIosAppsResponse
|
709
|
+
include Google::Apis::Core::Hashable
|
710
|
+
|
711
|
+
# List of each `IosApp` associated with the specified `FirebaseProject`.
|
712
|
+
# Corresponds to the JSON property `apps`
|
713
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::IosApp>]
|
714
|
+
attr_accessor :apps
|
715
|
+
|
716
|
+
# If the result list is too large to fit in a single response, then a token is
|
717
|
+
# returned. If the string is empty, then this response is the last page of
|
718
|
+
# results. This token can be used in a subsequent call to `ListIosApps` to find
|
719
|
+
# the next group of Apps. Page tokens are short-lived and should not be
|
720
|
+
# persisted.
|
721
|
+
# Corresponds to the JSON property `nextPageToken`
|
722
|
+
# @return [String]
|
723
|
+
attr_accessor :next_page_token
|
724
|
+
|
725
|
+
def initialize(**args)
|
726
|
+
update!(**args)
|
727
|
+
end
|
728
|
+
|
729
|
+
# Update properties of this object
|
730
|
+
def update!(**args)
|
731
|
+
@apps = args[:apps] if args.key?(:apps)
|
732
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
733
|
+
end
|
734
|
+
end
|
735
|
+
|
736
|
+
#
|
737
|
+
class ListShaCertificatesResponse
|
738
|
+
include Google::Apis::Core::Hashable
|
739
|
+
|
740
|
+
# The list of each `ShaCertificate` associated with the `AndroidApp`.
|
741
|
+
# Corresponds to the JSON property `certificates`
|
742
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::ShaCertificate>]
|
743
|
+
attr_accessor :certificates
|
744
|
+
|
745
|
+
def initialize(**args)
|
746
|
+
update!(**args)
|
747
|
+
end
|
748
|
+
|
749
|
+
# Update properties of this object
|
750
|
+
def update!(**args)
|
751
|
+
@certificates = args[:certificates] if args.key?(:certificates)
|
752
|
+
end
|
753
|
+
end
|
754
|
+
|
755
|
+
#
|
756
|
+
class ListWebAppsResponse
|
757
|
+
include Google::Apis::Core::Hashable
|
758
|
+
|
759
|
+
# List of each `WebApp` associated with the specified `FirebaseProject`.
|
760
|
+
# Corresponds to the JSON property `apps`
|
761
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::WebApp>]
|
762
|
+
attr_accessor :apps
|
763
|
+
|
764
|
+
# If the result list is too large to fit in a single response, then a token is
|
765
|
+
# returned. If the string is empty, then this response is the last page of
|
766
|
+
# results. This token can be used in a subsequent call to `ListWebApps` to find
|
767
|
+
# the next group of Apps. Page tokens are short-lived and should not be
|
768
|
+
# persisted.
|
769
|
+
# Corresponds to the JSON property `nextPageToken`
|
770
|
+
# @return [String]
|
771
|
+
attr_accessor :next_page_token
|
772
|
+
|
773
|
+
def initialize(**args)
|
774
|
+
update!(**args)
|
775
|
+
end
|
776
|
+
|
777
|
+
# Update properties of this object
|
778
|
+
def update!(**args)
|
779
|
+
@apps = args[:apps] if args.key?(:apps)
|
780
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
781
|
+
end
|
782
|
+
end
|
783
|
+
|
784
|
+
# A GCP resource location that can be selected for a FirebaseProject.
|
785
|
+
class Location
|
786
|
+
include Google::Apis::Core::Hashable
|
787
|
+
|
788
|
+
# Products and services that are available in the GCP resource location.
|
789
|
+
# Corresponds to the JSON property `features`
|
790
|
+
# @return [Array<String>]
|
791
|
+
attr_accessor :features
|
792
|
+
|
793
|
+
# The ID of the GCP resource location. It will be one of the available [GCP
|
794
|
+
# resource locations](https://firebase.google.com/docs/projects/locations#types).
|
795
|
+
# Corresponds to the JSON property `locationId`
|
796
|
+
# @return [String]
|
797
|
+
attr_accessor :location_id
|
798
|
+
|
799
|
+
# Indicates whether the GCP resource location is a [regional or multi-regional
|
800
|
+
# location](https://firebase.google.com/docs/projects/locations#types) for data
|
801
|
+
# replication.
|
802
|
+
# Corresponds to the JSON property `type`
|
803
|
+
# @return [String]
|
804
|
+
attr_accessor :type
|
805
|
+
|
806
|
+
def initialize(**args)
|
807
|
+
update!(**args)
|
808
|
+
end
|
809
|
+
|
810
|
+
# Update properties of this object
|
811
|
+
def update!(**args)
|
812
|
+
@features = args[:features] if args.key?(:features)
|
813
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
814
|
+
@type = args[:type] if args.key?(:type)
|
815
|
+
end
|
816
|
+
end
|
817
|
+
|
818
|
+
# This is proto2's version of MessageSet.
|
819
|
+
class MessageSet
|
820
|
+
include Google::Apis::Core::Hashable
|
821
|
+
|
822
|
+
def initialize(**args)
|
823
|
+
update!(**args)
|
824
|
+
end
|
825
|
+
|
826
|
+
# Update properties of this object
|
827
|
+
def update!(**args)
|
828
|
+
end
|
829
|
+
end
|
830
|
+
|
831
|
+
# This resource represents a long-running operation that is the result of a
|
832
|
+
# network API call.
|
833
|
+
class Operation
|
834
|
+
include Google::Apis::Core::Hashable
|
835
|
+
|
836
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
837
|
+
# , the operation is completed, and either `error` or `response` is available.
|
838
|
+
# Corresponds to the JSON property `done`
|
839
|
+
# @return [Boolean]
|
840
|
+
attr_accessor :done
|
841
|
+
alias_method :done?, :done
|
842
|
+
|
843
|
+
# The `Status` type defines a logical error model that is suitable for different
|
844
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
845
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
846
|
+
# data: error code, error message, and error details. You can find out more
|
847
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
848
|
+
# //cloud.google.com/apis/design/errors).
|
849
|
+
# Corresponds to the JSON property `error`
|
850
|
+
# @return [Google::Apis::FirebaseV1beta1::Status]
|
851
|
+
attr_accessor :error
|
852
|
+
|
853
|
+
# Service-specific metadata associated with the operation. It typically contains
|
854
|
+
# progress information and common metadata such as create time. Some services
|
855
|
+
# might not provide such metadata. Any method that returns a long-running
|
856
|
+
# operation should document the metadata type, if any.
|
857
|
+
# Corresponds to the JSON property `metadata`
|
858
|
+
# @return [Hash<String,Object>]
|
859
|
+
attr_accessor :metadata
|
860
|
+
|
861
|
+
# The server-assigned name, which is only unique within the same service that
|
862
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
863
|
+
# be a resource name ending with `operations/`unique_id``.
|
864
|
+
# Corresponds to the JSON property `name`
|
865
|
+
# @return [String]
|
866
|
+
attr_accessor :name
|
867
|
+
|
868
|
+
# The normal response of the operation in case of success. If the original
|
869
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
870
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
871
|
+
# the response should be the resource. For other methods, the response should
|
872
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
873
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
874
|
+
# response type is `TakeSnapshotResponse`.
|
875
|
+
# Corresponds to the JSON property `response`
|
876
|
+
# @return [Hash<String,Object>]
|
877
|
+
attr_accessor :response
|
878
|
+
|
879
|
+
def initialize(**args)
|
880
|
+
update!(**args)
|
881
|
+
end
|
882
|
+
|
883
|
+
# Update properties of this object
|
884
|
+
def update!(**args)
|
885
|
+
@done = args[:done] if args.key?(:done)
|
886
|
+
@error = args[:error] if args.key?(:error)
|
887
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
888
|
+
@name = args[:name] if args.key?(:name)
|
889
|
+
@response = args[:response] if args.key?(:response)
|
890
|
+
end
|
891
|
+
end
|
892
|
+
|
893
|
+
# A reference to a Google Cloud Platform (GCP) `Project`.
|
894
|
+
class ProjectInfo
|
895
|
+
include Google::Apis::Core::Hashable
|
896
|
+
|
897
|
+
# The user-assigned display name of the GCP `Project`, for example: `My App`
|
898
|
+
# Corresponds to the JSON property `displayName`
|
899
|
+
# @return [String]
|
900
|
+
attr_accessor :display_name
|
901
|
+
|
902
|
+
# The ID of the Project's default GCP resource location. The location is one of
|
903
|
+
# the available [GCP resource locations](https://firebase.google.com/docs/
|
904
|
+
# projects/locations). Not all Projects will have this field populated. If it is
|
905
|
+
# not populated, it means that the Project does not yet have a default GCP
|
906
|
+
# resource location. To set a Project's default GCP resource location, call [`
|
907
|
+
# FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add
|
908
|
+
# Firebase resources to the Project.
|
909
|
+
# Corresponds to the JSON property `locationId`
|
910
|
+
# @return [String]
|
911
|
+
attr_accessor :location_id
|
912
|
+
|
913
|
+
# The resource name of the GCP `Project` to which Firebase resources can be
|
914
|
+
# added, in the format: projects/PROJECT_IDENTIFIER Refer to the `
|
915
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
916
|
+
# details about PROJECT_IDENTIFIER values.
|
917
|
+
# Corresponds to the JSON property `project`
|
918
|
+
# @return [String]
|
919
|
+
attr_accessor :project
|
920
|
+
|
921
|
+
def initialize(**args)
|
922
|
+
update!(**args)
|
923
|
+
end
|
924
|
+
|
925
|
+
# Update properties of this object
|
926
|
+
def update!(**args)
|
927
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
928
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
929
|
+
@project = args[:project] if args.key?(:project)
|
930
|
+
end
|
931
|
+
end
|
932
|
+
|
933
|
+
#
|
934
|
+
class RemoveAnalyticsRequest
|
935
|
+
include Google::Apis::Core::Hashable
|
936
|
+
|
937
|
+
# Optional. The ID of the Google Analytics property associated with the
|
938
|
+
# specified `FirebaseProject`. - If not set, then the Google Analytics property
|
939
|
+
# that is currently associated with the specified `FirebaseProject` is removed. -
|
940
|
+
# If set, and the specified `FirebaseProject` is currently associated with a *
|
941
|
+
# different* Google Analytics property, then the response is a `412 Precondition
|
942
|
+
# Failed` error.
|
943
|
+
# Corresponds to the JSON property `analyticsPropertyId`
|
944
|
+
# @return [String]
|
945
|
+
attr_accessor :analytics_property_id
|
946
|
+
|
947
|
+
def initialize(**args)
|
948
|
+
update!(**args)
|
949
|
+
end
|
950
|
+
|
951
|
+
# Update properties of this object
|
952
|
+
def update!(**args)
|
953
|
+
@analytics_property_id = args[:analytics_property_id] if args.key?(:analytics_property_id)
|
954
|
+
end
|
955
|
+
end
|
956
|
+
|
957
|
+
#
|
958
|
+
class SearchFirebaseAppsResponse
|
959
|
+
include Google::Apis::Core::Hashable
|
960
|
+
|
961
|
+
# One page of results from a call to `SearchFirebaseApps`.
|
962
|
+
# Corresponds to the JSON property `apps`
|
963
|
+
# @return [Array<Google::Apis::FirebaseV1beta1::FirebaseAppInfo>]
|
964
|
+
attr_accessor :apps
|
965
|
+
|
966
|
+
# If the result list is too large to fit in a single response, then a token is
|
967
|
+
# returned. This token can be used in a subsequent calls to `SearchFirebaseApps`
|
968
|
+
# to find the next group of Apps. Page tokens are short-lived and should not be
|
969
|
+
# persisted.
|
970
|
+
# Corresponds to the JSON property `nextPageToken`
|
971
|
+
# @return [String]
|
972
|
+
attr_accessor :next_page_token
|
973
|
+
|
974
|
+
def initialize(**args)
|
975
|
+
update!(**args)
|
976
|
+
end
|
977
|
+
|
978
|
+
# Update properties of this object
|
979
|
+
def update!(**args)
|
980
|
+
@apps = args[:apps] if args.key?(:apps)
|
981
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
982
|
+
end
|
983
|
+
end
|
984
|
+
|
985
|
+
# A SHA-1 or SHA-256 certificate associated with the AndroidApp.
|
986
|
+
class ShaCertificate
|
987
|
+
include Google::Apis::Core::Hashable
|
988
|
+
|
989
|
+
# The type of SHA certificate encoded in the hash.
|
990
|
+
# Corresponds to the JSON property `certType`
|
991
|
+
# @return [String]
|
992
|
+
attr_accessor :cert_type
|
993
|
+
|
994
|
+
# The resource name of the ShaCertificate for the AndroidApp, in the format:
|
995
|
+
# projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH *
|
996
|
+
# PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#
|
997
|
+
# FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`]
|
998
|
+
# (../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
999
|
+
# project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/
|
1000
|
+
# cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body
|
1001
|
+
# will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned
|
1002
|
+
# identifier for the App (see [`appId`](../projects.androidApps#AndroidApp.
|
1003
|
+
# FIELDS.app_id)). * SHA_HASH: the certificate hash for the App (see [`shaHash`](
|
1004
|
+
# ../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)).
|
1005
|
+
# Corresponds to the JSON property `name`
|
1006
|
+
# @return [String]
|
1007
|
+
attr_accessor :name
|
1008
|
+
|
1009
|
+
# The certificate hash for the `AndroidApp`.
|
1010
|
+
# Corresponds to the JSON property `shaHash`
|
1011
|
+
# @return [String]
|
1012
|
+
attr_accessor :sha_hash
|
1013
|
+
|
1014
|
+
def initialize(**args)
|
1015
|
+
update!(**args)
|
1016
|
+
end
|
1017
|
+
|
1018
|
+
# Update properties of this object
|
1019
|
+
def update!(**args)
|
1020
|
+
@cert_type = args[:cert_type] if args.key?(:cert_type)
|
1021
|
+
@name = args[:name] if args.key?(:name)
|
1022
|
+
@sha_hash = args[:sha_hash] if args.key?(:sha_hash)
|
1023
|
+
end
|
1024
|
+
end
|
1025
|
+
|
1026
|
+
# The `Status` type defines a logical error model that is suitable for different
|
1027
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
1028
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
1029
|
+
# data: error code, error message, and error details. You can find out more
|
1030
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
1031
|
+
# //cloud.google.com/apis/design/errors).
|
1032
|
+
class Status
|
1033
|
+
include Google::Apis::Core::Hashable
|
1034
|
+
|
1035
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
1036
|
+
# Corresponds to the JSON property `code`
|
1037
|
+
# @return [Fixnum]
|
1038
|
+
attr_accessor :code
|
1039
|
+
|
1040
|
+
# A list of messages that carry the error details. There is a common set of
|
1041
|
+
# message types for APIs to use.
|
1042
|
+
# Corresponds to the JSON property `details`
|
1043
|
+
# @return [Array<Hash<String,Object>>]
|
1044
|
+
attr_accessor :details
|
1045
|
+
|
1046
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
1047
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
1048
|
+
# field, or localized by the client.
|
1049
|
+
# Corresponds to the JSON property `message`
|
1050
|
+
# @return [String]
|
1051
|
+
attr_accessor :message
|
1052
|
+
|
1053
|
+
def initialize(**args)
|
1054
|
+
update!(**args)
|
1055
|
+
end
|
1056
|
+
|
1057
|
+
# Update properties of this object
|
1058
|
+
def update!(**args)
|
1059
|
+
@code = args[:code] if args.key?(:code)
|
1060
|
+
@details = args[:details] if args.key?(:details)
|
1061
|
+
@message = args[:message] if args.key?(:message)
|
1062
|
+
end
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# Wire-format for a Status object
|
1066
|
+
class StatusProto
|
1067
|
+
include Google::Apis::Core::Hashable
|
1068
|
+
|
1069
|
+
# The canonical error code (see codes.proto) that most closely corresponds to
|
1070
|
+
# this status. May be missing.
|
1071
|
+
# Corresponds to the JSON property `canonicalCode`
|
1072
|
+
# @return [Fixnum]
|
1073
|
+
attr_accessor :canonical_code
|
1074
|
+
|
1075
|
+
# Numeric code drawn from the space specified below. Often, this is the
|
1076
|
+
# canonical error space, and code is drawn from google3/util/task/codes.proto
|
1077
|
+
# Corresponds to the JSON property `code`
|
1078
|
+
# @return [Fixnum]
|
1079
|
+
attr_accessor :code
|
1080
|
+
|
1081
|
+
# Detail message
|
1082
|
+
# Corresponds to the JSON property `message`
|
1083
|
+
# @return [String]
|
1084
|
+
attr_accessor :message
|
1085
|
+
|
1086
|
+
# This is proto2's version of MessageSet.
|
1087
|
+
# Corresponds to the JSON property `messageSet`
|
1088
|
+
# @return [Google::Apis::FirebaseV1beta1::MessageSet]
|
1089
|
+
attr_accessor :message_set
|
1090
|
+
|
1091
|
+
# The following are usually only present when code != 0 Space to which this
|
1092
|
+
# status belongs
|
1093
|
+
# Corresponds to the JSON property `space`
|
1094
|
+
# @return [String]
|
1095
|
+
attr_accessor :space
|
1096
|
+
|
1097
|
+
def initialize(**args)
|
1098
|
+
update!(**args)
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# Update properties of this object
|
1102
|
+
def update!(**args)
|
1103
|
+
@canonical_code = args[:canonical_code] if args.key?(:canonical_code)
|
1104
|
+
@code = args[:code] if args.key?(:code)
|
1105
|
+
@message = args[:message] if args.key?(:message)
|
1106
|
+
@message_set = args[:message_set] if args.key?(:message_set)
|
1107
|
+
@space = args[:space] if args.key?(:space)
|
1108
|
+
end
|
1109
|
+
end
|
1110
|
+
|
1111
|
+
# A mapping of a Firebase App to a Google Analytics data stream
|
1112
|
+
class StreamMapping
|
1113
|
+
include Google::Apis::Core::Hashable
|
1114
|
+
|
1115
|
+
# The resource name of the Firebase App associated with the Google Analytics
|
1116
|
+
# data stream, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID or
|
1117
|
+
# projects/PROJECT_IDENTIFIER/iosApps/APP_ID or projects/PROJECT_IDENTIFIER /
|
1118
|
+
# webApps/APP_ID Refer to the `FirebaseProject` [`name`](../projects#
|
1119
|
+
# FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
1120
|
+
# Corresponds to the JSON property `app`
|
1121
|
+
# @return [String]
|
1122
|
+
attr_accessor :app
|
1123
|
+
|
1124
|
+
# Applicable for Firebase Web Apps only. The unique Google-assigned identifier
|
1125
|
+
# of the Google Analytics web stream associated with the Firebase Web App.
|
1126
|
+
# Firebase SDKs use this ID to interact with Google Analytics APIs. Learn more
|
1127
|
+
# about this ID and Google Analytics web streams in the [Analytics documentation]
|
1128
|
+
# (https://support.google.com/analytics/topic/9303475).
|
1129
|
+
# Corresponds to the JSON property `measurementId`
|
1130
|
+
# @return [String]
|
1131
|
+
attr_accessor :measurement_id
|
1132
|
+
|
1133
|
+
# The unique Google-assigned identifier of the Google Analytics data stream
|
1134
|
+
# associated with the Firebase App. Learn more about Google Analytics data
|
1135
|
+
# streams in the [Analytics documentation](https://support.google.com/analytics/
|
1136
|
+
# answer/9303323).
|
1137
|
+
# Corresponds to the JSON property `streamId`
|
1138
|
+
# @return [Fixnum]
|
1139
|
+
attr_accessor :stream_id
|
1140
|
+
|
1141
|
+
def initialize(**args)
|
1142
|
+
update!(**args)
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
# Update properties of this object
|
1146
|
+
def update!(**args)
|
1147
|
+
@app = args[:app] if args.key?(:app)
|
1148
|
+
@measurement_id = args[:measurement_id] if args.key?(:measurement_id)
|
1149
|
+
@stream_id = args[:stream_id] if args.key?(:stream_id)
|
1150
|
+
end
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Details of a Firebase App for the web.
|
1154
|
+
class WebApp
|
1155
|
+
include Google::Apis::Core::Hashable
|
1156
|
+
|
1157
|
+
# Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`.
|
1158
|
+
# This identifier should be treated as an opaque token, as the data format is
|
1159
|
+
# not specified.
|
1160
|
+
# Corresponds to the JSON property `appId`
|
1161
|
+
# @return [String]
|
1162
|
+
attr_accessor :app_id
|
1163
|
+
|
1164
|
+
# The URLs where the `WebApp` is hosted.
|
1165
|
+
# Corresponds to the JSON property `appUrls`
|
1166
|
+
# @return [Array<String>]
|
1167
|
+
attr_accessor :app_urls
|
1168
|
+
|
1169
|
+
# The user-assigned display name for the `WebApp`.
|
1170
|
+
# Corresponds to the JSON property `displayName`
|
1171
|
+
# @return [String]
|
1172
|
+
attr_accessor :display_name
|
1173
|
+
|
1174
|
+
# The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /
|
1175
|
+
# webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../
|
1176
|
+
# projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`
|
1177
|
+
# ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
1178
|
+
# using project identifiers in Google's [AIP 2510 standard](https://google.aip.
|
1179
|
+
# dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response
|
1180
|
+
# body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned
|
1181
|
+
# identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)
|
1182
|
+
# ).
|
1183
|
+
# Corresponds to the JSON property `name`
|
1184
|
+
# @return [String]
|
1185
|
+
attr_accessor :name
|
1186
|
+
|
1187
|
+
# Immutable. A user-assigned unique identifier of the parent FirebaseProject for
|
1188
|
+
# the `WebApp`.
|
1189
|
+
# Corresponds to the JSON property `projectId`
|
1190
|
+
# @return [String]
|
1191
|
+
attr_accessor :project_id
|
1192
|
+
|
1193
|
+
# Output only. Immutable. A unique, Firebase-assigned identifier for the `WebApp`
|
1194
|
+
# . This identifier is only used to populate the `namespace` value for the `
|
1195
|
+
# WebApp`. For most use cases, use `appId` to identify or reference the App. The
|
1196
|
+
# `webId` value is only unique within a `FirebaseProject` and its associated
|
1197
|
+
# Apps.
|
1198
|
+
# Corresponds to the JSON property `webId`
|
1199
|
+
# @return [String]
|
1200
|
+
attr_accessor :web_id
|
1201
|
+
|
1202
|
+
def initialize(**args)
|
1203
|
+
update!(**args)
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# Update properties of this object
|
1207
|
+
def update!(**args)
|
1208
|
+
@app_id = args[:app_id] if args.key?(:app_id)
|
1209
|
+
@app_urls = args[:app_urls] if args.key?(:app_urls)
|
1210
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
1211
|
+
@name = args[:name] if args.key?(:name)
|
1212
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1213
|
+
@web_id = args[:web_id] if args.key?(:web_id)
|
1214
|
+
end
|
1215
|
+
end
|
1216
|
+
|
1217
|
+
# Configuration metadata of a single Firebase App for the web.
|
1218
|
+
class WebAppConfig
|
1219
|
+
include Google::Apis::Core::Hashable
|
1220
|
+
|
1221
|
+
# The API key associated with the `WebApp`.
|
1222
|
+
# Corresponds to the JSON property `apiKey`
|
1223
|
+
# @return [String]
|
1224
|
+
attr_accessor :api_key
|
1225
|
+
|
1226
|
+
# Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`.
|
1227
|
+
# Corresponds to the JSON property `appId`
|
1228
|
+
# @return [String]
|
1229
|
+
attr_accessor :app_id
|
1230
|
+
|
1231
|
+
# The domain Firebase Auth configures for OAuth redirects, in the format:
|
1232
|
+
# PROJECT_ID.firebaseapp.com
|
1233
|
+
# Corresponds to the JSON property `authDomain`
|
1234
|
+
# @return [String]
|
1235
|
+
attr_accessor :auth_domain
|
1236
|
+
|
1237
|
+
# The default Firebase Realtime Database URL.
|
1238
|
+
# Corresponds to the JSON property `databaseURL`
|
1239
|
+
# @return [String]
|
1240
|
+
attr_accessor :database_url
|
1241
|
+
|
1242
|
+
# The ID of the Project's default GCP resource location. The location is one of
|
1243
|
+
# the available [GCP resource locations](https://firebase.google.com/docs/
|
1244
|
+
# projects/locations). This field is omitted if the default GCP resource
|
1245
|
+
# location has not been finalized yet. To set a Project's default GCP resource
|
1246
|
+
# location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/
|
1247
|
+
# finalize) after you add Firebase resources to the Project.
|
1248
|
+
# Corresponds to the JSON property `locationId`
|
1249
|
+
# @return [String]
|
1250
|
+
attr_accessor :location_id
|
1251
|
+
|
1252
|
+
# The unique Google-assigned identifier of the Google Analytics web stream
|
1253
|
+
# associated with the `WebApp`. Firebase SDKs use this ID to interact with
|
1254
|
+
# Google Analytics APIs. This field is only present if the `WebApp` is linked to
|
1255
|
+
# a web stream in a Google Analytics App + Web property. Learn more about this
|
1256
|
+
# ID and Google Analytics web streams in the [Analytics documentation](https://
|
1257
|
+
# support.google.com/analytics/topic/9303475). To generate a `measurementId` and
|
1258
|
+
# link the `WebApp` with a Google Analytics web stream, call [`
|
1259
|
+
# AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics). For apps
|
1260
|
+
# using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically
|
1261
|
+
# fetches the `measurementId` when your app initializes Analytics. Having this
|
1262
|
+
# ID in your config object is optional, but it does serve as a fallback in the
|
1263
|
+
# rare case that the dynamic fetch fails.
|
1264
|
+
# Corresponds to the JSON property `measurementId`
|
1265
|
+
# @return [String]
|
1266
|
+
attr_accessor :measurement_id
|
1267
|
+
|
1268
|
+
# The sender ID for use with Firebase Cloud Messaging.
|
1269
|
+
# Corresponds to the JSON property `messagingSenderId`
|
1270
|
+
# @return [String]
|
1271
|
+
attr_accessor :messaging_sender_id
|
1272
|
+
|
1273
|
+
# Immutable. A user-assigned unique identifier for the `FirebaseProject`.
|
1274
|
+
# Corresponds to the JSON property `projectId`
|
1275
|
+
# @return [String]
|
1276
|
+
attr_accessor :project_id
|
1277
|
+
|
1278
|
+
# The default Cloud Storage for Firebase storage bucket name.
|
1279
|
+
# Corresponds to the JSON property `storageBucket`
|
1280
|
+
# @return [String]
|
1281
|
+
attr_accessor :storage_bucket
|
1282
|
+
|
1283
|
+
def initialize(**args)
|
1284
|
+
update!(**args)
|
1285
|
+
end
|
1286
|
+
|
1287
|
+
# Update properties of this object
|
1288
|
+
def update!(**args)
|
1289
|
+
@api_key = args[:api_key] if args.key?(:api_key)
|
1290
|
+
@app_id = args[:app_id] if args.key?(:app_id)
|
1291
|
+
@auth_domain = args[:auth_domain] if args.key?(:auth_domain)
|
1292
|
+
@database_url = args[:database_url] if args.key?(:database_url)
|
1293
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
1294
|
+
@measurement_id = args[:measurement_id] if args.key?(:measurement_id)
|
1295
|
+
@messaging_sender_id = args[:messaging_sender_id] if args.key?(:messaging_sender_id)
|
1296
|
+
@project_id = args[:project_id] if args.key?(:project_id)
|
1297
|
+
@storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
|
1298
|
+
end
|
1299
|
+
end
|
1300
|
+
end
|
1301
|
+
end
|
1302
|
+
end
|