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
|
@@ -0,0 +1,1386 @@
|
|
|
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/core/base_service'
|
|
16
|
+
require 'google/apis/core/json_representation'
|
|
17
|
+
require 'google/apis/core/hashable'
|
|
18
|
+
require 'google/apis/errors'
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Apis
|
|
22
|
+
module FirebaseV1beta1
|
|
23
|
+
# Firebase Management API
|
|
24
|
+
#
|
|
25
|
+
# The Firebase Management API enables programmatic setup and management of
|
|
26
|
+
# Firebase projects, including a project's Firebase resources and Firebase apps.
|
|
27
|
+
#
|
|
28
|
+
# @example
|
|
29
|
+
# require 'google/apis/firebase_v1beta1'
|
|
30
|
+
#
|
|
31
|
+
# Firebase = Google::Apis::FirebaseV1beta1 # Alias the module
|
|
32
|
+
# service = Firebase::FirebaseManagementService.new
|
|
33
|
+
#
|
|
34
|
+
# @see https://firebase.google.com
|
|
35
|
+
class FirebaseManagementService < Google::Apis::Core::BaseService
|
|
36
|
+
# @return [String]
|
|
37
|
+
# API key. Your API key identifies your project and provides you with API access,
|
|
38
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
39
|
+
attr_accessor :key
|
|
40
|
+
|
|
41
|
+
# @return [String]
|
|
42
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
43
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
44
|
+
attr_accessor :quota_user
|
|
45
|
+
|
|
46
|
+
def initialize
|
|
47
|
+
super('https://firebase.googleapis.com/', '',
|
|
48
|
+
client_name: 'google-apis-firebase_v1beta1',
|
|
49
|
+
client_version: Google::Apis::FirebaseV1beta1::GEM_VERSION)
|
|
50
|
+
@batch_path = 'batch'
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/
|
|
54
|
+
# resource-manager/reference/rest/v1/projects) that can have Firebase resources
|
|
55
|
+
# added to it. A Project will only be listed if: - The caller has sufficient [
|
|
56
|
+
# Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. -
|
|
57
|
+
# The Project is not already a FirebaseProject. - The Project is not in an
|
|
58
|
+
# Organization which has policies that prevent Firebase resources from being
|
|
59
|
+
# added.
|
|
60
|
+
# @param [Fixnum] page_size
|
|
61
|
+
# The maximum number of Projects to return in the response. The server may
|
|
62
|
+
# return fewer than this value at its discretion. If no value is specified (or
|
|
63
|
+
# too large a value is specified), the server will impose its own limit. This
|
|
64
|
+
# value cannot be negative.
|
|
65
|
+
# @param [String] page_token
|
|
66
|
+
# Token returned from a previous call to `ListAvailableProjects` indicating
|
|
67
|
+
# where in the set of Projects to resume listing.
|
|
68
|
+
# @param [String] fields
|
|
69
|
+
# Selector specifying which fields to include in a partial response.
|
|
70
|
+
# @param [String] quota_user
|
|
71
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
72
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
73
|
+
# @param [Google::Apis::RequestOptions] options
|
|
74
|
+
# Request-specific options
|
|
75
|
+
#
|
|
76
|
+
# @yield [result, err] Result & error if block supplied
|
|
77
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse] parsed result object
|
|
78
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
79
|
+
#
|
|
80
|
+
# @return [Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse]
|
|
81
|
+
#
|
|
82
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
83
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
84
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
85
|
+
def list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
86
|
+
command = make_simple_command(:get, 'v1beta1/availableProjects', options)
|
|
87
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse::Representation
|
|
88
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse
|
|
89
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
90
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
91
|
+
command.query['fields'] = fields unless fields.nil?
|
|
92
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
93
|
+
execute_or_queue_command(command, &block)
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
97
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
98
|
+
# @param [String] name
|
|
99
|
+
# The name of the operation resource.
|
|
100
|
+
# @param [String] fields
|
|
101
|
+
# Selector specifying which fields to include in a partial response.
|
|
102
|
+
# @param [String] quota_user
|
|
103
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
104
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
105
|
+
# @param [Google::Apis::RequestOptions] options
|
|
106
|
+
# Request-specific options
|
|
107
|
+
#
|
|
108
|
+
# @yield [result, err] Result & error if block supplied
|
|
109
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
110
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
111
|
+
#
|
|
112
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
113
|
+
#
|
|
114
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
115
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
116
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
117
|
+
def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
118
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
119
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
120
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
121
|
+
command.params['name'] = name unless name.nil?
|
|
122
|
+
command.query['fields'] = fields unless fields.nil?
|
|
123
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
124
|
+
execute_or_queue_command(command, &block)
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# Adds Firebase resources to the specified existing [Google Cloud Platform (GCP)
|
|
128
|
+
# `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/
|
|
129
|
+
# projects). Since a FirebaseProject is actually also a GCP `Project`, a `
|
|
130
|
+
# FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and `
|
|
131
|
+
# projectId`). This allows for easy interop with Google APIs. The result of this
|
|
132
|
+
# call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to
|
|
133
|
+
# track the provisioning process by calling GetOperation until [`done`](../../
|
|
134
|
+
# v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`,
|
|
135
|
+
# the `Operation` has either succeeded or failed. If the `Operation` succeeded,
|
|
136
|
+
# its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to
|
|
137
|
+
# a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/
|
|
138
|
+
# operations#Operation.FIELDS.error) is set to a google.rpc.Status. The `
|
|
139
|
+
# Operation` is automatically deleted after completion, so there is no need to
|
|
140
|
+
# call DeleteOperation. This method does not modify any billing account
|
|
141
|
+
# information on the underlying GCP `Project`. To call `AddFirebase`, a project
|
|
142
|
+
# member or service account must have the following permissions (the IAM roles
|
|
143
|
+
# of Editor and Owner contain these permissions): `firebase.projects.update`, `
|
|
144
|
+
# resourcemanager.projects.get`, `serviceusage.services.enable`, and `
|
|
145
|
+
# serviceusage.services.get`.
|
|
146
|
+
# @param [String] project
|
|
147
|
+
# The resource name of the GCP `Project` to which Firebase resources will be
|
|
148
|
+
# added, in the format: projects/PROJECT_IDENTIFIER Refer to the `
|
|
149
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
150
|
+
# details about PROJECT_IDENTIFIER values. After calling `AddFirebase`, the
|
|
151
|
+
# unique Project identifiers ( [`projectNumber`](https://cloud.google.com/
|
|
152
|
+
# resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number) and
|
|
153
|
+
# [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/
|
|
154
|
+
# projects#Project.FIELDS.project_id)) of the underlying GCP `Project` are also
|
|
155
|
+
# the identifiers of the FirebaseProject.
|
|
156
|
+
# @param [Google::Apis::FirebaseV1beta1::AddFirebaseRequest] add_firebase_request_object
|
|
157
|
+
# @param [String] fields
|
|
158
|
+
# Selector specifying which fields to include in a partial response.
|
|
159
|
+
# @param [String] quota_user
|
|
160
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
161
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
162
|
+
# @param [Google::Apis::RequestOptions] options
|
|
163
|
+
# Request-specific options
|
|
164
|
+
#
|
|
165
|
+
# @yield [result, err] Result & error if block supplied
|
|
166
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
167
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
168
|
+
#
|
|
169
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
170
|
+
#
|
|
171
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
172
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
173
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
174
|
+
def add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
175
|
+
command = make_simple_command(:post, 'v1beta1/{+project}:addFirebase', options)
|
|
176
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::AddFirebaseRequest::Representation
|
|
177
|
+
command.request_object = add_firebase_request_object
|
|
178
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
179
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
180
|
+
command.params['project'] = project unless project.nil?
|
|
181
|
+
command.query['fields'] = fields unless fields.nil?
|
|
182
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
183
|
+
execute_or_queue_command(command, &block)
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Links the specified FirebaseProject with an existing [Google Analytics account]
|
|
187
|
+
# (http://www.google.com/analytics/). Using this call, you can either: - Specify
|
|
188
|
+
# an `analyticsAccountId` to provision a new Google Analytics property within
|
|
189
|
+
# the specified account and associate the new property with the `FirebaseProject`
|
|
190
|
+
# . - Specify an existing `analyticsPropertyId` to associate the property with
|
|
191
|
+
# the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The
|
|
192
|
+
# first check determines if any existing data streams in the Google Analytics
|
|
193
|
+
# property correspond to any existing Firebase Apps in the `FirebaseProject` (
|
|
194
|
+
# based on the `packageName` or `bundleId` associated with the data stream).
|
|
195
|
+
# Then, as applicable, the data streams and apps are linked. Note that this auto-
|
|
196
|
+
# linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding
|
|
197
|
+
# data streams are found for the Firebase Apps, new data streams are provisioned
|
|
198
|
+
# in the Google Analytics property for each of the Firebase Apps. Note that a
|
|
199
|
+
# new data stream is always provisioned for a Web App even if it was previously
|
|
200
|
+
# associated with a data stream in the Analytics property. Learn more about the
|
|
201
|
+
# hierarchy and structure of Google Analytics accounts in the [Analytics
|
|
202
|
+
# documentation](https://support.google.com/analytics/answer/9303323). The
|
|
203
|
+
# result of this call is an [`Operation`](../../v1beta1/operations). Poll the `
|
|
204
|
+
# Operation` to track the provisioning process by calling GetOperation until [`
|
|
205
|
+
# done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done`
|
|
206
|
+
# is `true`, the `Operation` has either succeeded or failed. If the `Operation`
|
|
207
|
+
# succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response)
|
|
208
|
+
# is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../
|
|
209
|
+
# v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To
|
|
210
|
+
# call `AddGoogleAnalytics`, a project member must be an Owner for the existing `
|
|
211
|
+
# FirebaseProject` and have the [`Edit` permission](https://support.google.com/
|
|
212
|
+
# analytics/answer/2884495) for the Google Analytics account. If the `
|
|
213
|
+
# FirebaseProject` already has Google Analytics enabled, and you call `
|
|
214
|
+
# AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the
|
|
215
|
+
# currently associated property, then the call will fail. Analytics may have
|
|
216
|
+
# already been enabled in the Firebase console or by specifying `timeZone` and `
|
|
217
|
+
# regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase).
|
|
218
|
+
# @param [String] parent
|
|
219
|
+
# The resource name of the FirebaseProject to link to an existing Google
|
|
220
|
+
# Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the `
|
|
221
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
222
|
+
# details about PROJECT_IDENTIFIER values.
|
|
223
|
+
# @param [Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest] add_google_analytics_request_object
|
|
224
|
+
# @param [String] fields
|
|
225
|
+
# Selector specifying which fields to include in a partial response.
|
|
226
|
+
# @param [String] quota_user
|
|
227
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
228
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
229
|
+
# @param [Google::Apis::RequestOptions] options
|
|
230
|
+
# Request-specific options
|
|
231
|
+
#
|
|
232
|
+
# @yield [result, err] Result & error if block supplied
|
|
233
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
234
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
235
|
+
#
|
|
236
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
237
|
+
#
|
|
238
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
239
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
240
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
241
|
+
def add_project_google_analytics(parent, add_google_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
242
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}:addGoogleAnalytics', options)
|
|
243
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest::Representation
|
|
244
|
+
command.request_object = add_google_analytics_request_object
|
|
245
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
246
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
247
|
+
command.params['parent'] = parent unless parent.nil?
|
|
248
|
+
command.query['fields'] = fields unless fields.nil?
|
|
249
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
250
|
+
execute_or_queue_command(command, &block)
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
# Gets the specified FirebaseProject.
|
|
254
|
+
# @param [String] name
|
|
255
|
+
# The resource name of the FirebaseProject, in the format: projects/
|
|
256
|
+
# PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#
|
|
257
|
+
# FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
258
|
+
# @param [String] fields
|
|
259
|
+
# Selector specifying which fields to include in a partial response.
|
|
260
|
+
# @param [String] quota_user
|
|
261
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
262
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
263
|
+
# @param [Google::Apis::RequestOptions] options
|
|
264
|
+
# Request-specific options
|
|
265
|
+
#
|
|
266
|
+
# @yield [result, err] Result & error if block supplied
|
|
267
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::FirebaseProject] parsed result object
|
|
268
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
269
|
+
#
|
|
270
|
+
# @return [Google::Apis::FirebaseV1beta1::FirebaseProject]
|
|
271
|
+
#
|
|
272
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
273
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
274
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
275
|
+
def get_project(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
276
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
277
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
|
|
278
|
+
command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject
|
|
279
|
+
command.params['name'] = name unless name.nil?
|
|
280
|
+
command.query['fields'] = fields unless fields.nil?
|
|
281
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
282
|
+
execute_or_queue_command(command, &block)
|
|
283
|
+
end
|
|
284
|
+
|
|
285
|
+
# Gets the configuration artifact associated with the specified FirebaseProject,
|
|
286
|
+
# which can be used by servers to simplify initialization. Typically, this
|
|
287
|
+
# configuration is used with the Firebase Admin SDK [initializeApp](https://
|
|
288
|
+
# firebase.google.com/docs/admin/setup#initialize_the_sdk) command.
|
|
289
|
+
# @param [String] name
|
|
290
|
+
# The resource name of the FirebaseProject, in the format: projects/
|
|
291
|
+
# PROJECT_IDENTIFIER/adminSdkConfig Refer to the `FirebaseProject` [`name`](../
|
|
292
|
+
# projects#FirebaseProject.FIELDS.name) field for details about
|
|
293
|
+
# PROJECT_IDENTIFIER values.
|
|
294
|
+
# @param [String] fields
|
|
295
|
+
# Selector specifying which fields to include in a partial response.
|
|
296
|
+
# @param [String] quota_user
|
|
297
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
298
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
299
|
+
# @param [Google::Apis::RequestOptions] options
|
|
300
|
+
# Request-specific options
|
|
301
|
+
#
|
|
302
|
+
# @yield [result, err] Result & error if block supplied
|
|
303
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::AdminSdkConfig] parsed result object
|
|
304
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
305
|
+
#
|
|
306
|
+
# @return [Google::Apis::FirebaseV1beta1::AdminSdkConfig]
|
|
307
|
+
#
|
|
308
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
309
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
310
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
311
|
+
def get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
312
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
313
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::AdminSdkConfig::Representation
|
|
314
|
+
command.response_class = Google::Apis::FirebaseV1beta1::AdminSdkConfig
|
|
315
|
+
command.params['name'] = name unless name.nil?
|
|
316
|
+
command.query['fields'] = fields unless fields.nil?
|
|
317
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
318
|
+
execute_or_queue_command(command, &block)
|
|
319
|
+
end
|
|
320
|
+
|
|
321
|
+
# Gets the Google Analytics details currently associated with the specified
|
|
322
|
+
# FirebaseProject. If the `FirebaseProject` is not yet linked to Google
|
|
323
|
+
# Analytics, then the response to `GetAnalyticsDetails` is `NOT_FOUND`.
|
|
324
|
+
# @param [String] name
|
|
325
|
+
# The resource name of the FirebaseProject, in the format: projects/
|
|
326
|
+
# PROJECT_IDENTIFIER/analyticsDetails Refer to the `FirebaseProject` [`name`](../
|
|
327
|
+
# projects#FirebaseProject.FIELDS.name) field for details about
|
|
328
|
+
# PROJECT_IDENTIFIER values.
|
|
329
|
+
# @param [String] fields
|
|
330
|
+
# Selector specifying which fields to include in a partial response.
|
|
331
|
+
# @param [String] quota_user
|
|
332
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
333
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
334
|
+
# @param [Google::Apis::RequestOptions] options
|
|
335
|
+
# Request-specific options
|
|
336
|
+
#
|
|
337
|
+
# @yield [result, err] Result & error if block supplied
|
|
338
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::AnalyticsDetails] parsed result object
|
|
339
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
340
|
+
#
|
|
341
|
+
# @return [Google::Apis::FirebaseV1beta1::AnalyticsDetails]
|
|
342
|
+
#
|
|
343
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
344
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
345
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
346
|
+
def get_project_analytics_details(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
347
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
348
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::AnalyticsDetails::Representation
|
|
349
|
+
command.response_class = Google::Apis::FirebaseV1beta1::AnalyticsDetails
|
|
350
|
+
command.params['name'] = name unless name.nil?
|
|
351
|
+
command.query['fields'] = fields unless fields.nil?
|
|
352
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
353
|
+
execute_or_queue_command(command, &block)
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# Lists each FirebaseProject accessible to the caller. The elements are returned
|
|
357
|
+
# in no particular order, but they will be a consistent view of the Projects
|
|
358
|
+
# when additional requests are made with a `pageToken`. This method is
|
|
359
|
+
# eventually consistent with Project mutations, which means newly provisioned
|
|
360
|
+
# Projects and recent modifications to existing Projects might not be reflected
|
|
361
|
+
# in the set of Projects. The list will include only ACTIVE Projects. Use
|
|
362
|
+
# GetFirebaseProject for consistent reads as well as for additional Project
|
|
363
|
+
# details.
|
|
364
|
+
# @param [Fixnum] page_size
|
|
365
|
+
# The maximum number of Projects to return in the response. The server may
|
|
366
|
+
# return fewer than this at its discretion. If no value is specified (or too
|
|
367
|
+
# large a value is specified), the server will impose its own limit. This value
|
|
368
|
+
# cannot be negative.
|
|
369
|
+
# @param [String] page_token
|
|
370
|
+
# Token returned from a previous call to `ListFirebaseProjects` indicating where
|
|
371
|
+
# in the set of Projects to resume listing.
|
|
372
|
+
# @param [String] fields
|
|
373
|
+
# Selector specifying which fields to include in a partial response.
|
|
374
|
+
# @param [String] quota_user
|
|
375
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
376
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
377
|
+
# @param [Google::Apis::RequestOptions] options
|
|
378
|
+
# Request-specific options
|
|
379
|
+
#
|
|
380
|
+
# @yield [result, err] Result & error if block supplied
|
|
381
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse] parsed result object
|
|
382
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
383
|
+
#
|
|
384
|
+
# @return [Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse]
|
|
385
|
+
#
|
|
386
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
387
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
388
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
389
|
+
def list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
390
|
+
command = make_simple_command(:get, 'v1beta1/projects', options)
|
|
391
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse::Representation
|
|
392
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse
|
|
393
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
394
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
395
|
+
command.query['fields'] = fields unless fields.nil?
|
|
396
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
397
|
+
execute_or_queue_command(command, &block)
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
# Updates the attributes of the specified FirebaseProject. All [query parameters]
|
|
401
|
+
# (#query-parameters) are required.
|
|
402
|
+
# @param [String] name
|
|
403
|
+
# The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER
|
|
404
|
+
# PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects#
|
|
405
|
+
# FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`]
|
|
406
|
+
# (../projects#FirebaseProject.FIELDS.project_id). Learn more about using
|
|
407
|
+
# project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/
|
|
408
|
+
# cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body
|
|
409
|
+
# will be the `ProjectId`.
|
|
410
|
+
# @param [Google::Apis::FirebaseV1beta1::FirebaseProject] firebase_project_object
|
|
411
|
+
# @param [String] update_mask
|
|
412
|
+
# Specifies which fields to update. If this list is empty, then no state will be
|
|
413
|
+
# updated. Note that the fields `name`, `projectId`, and `projectNumber` are all
|
|
414
|
+
# immutable.
|
|
415
|
+
# @param [String] fields
|
|
416
|
+
# Selector specifying which fields to include in a partial response.
|
|
417
|
+
# @param [String] quota_user
|
|
418
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
419
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
420
|
+
# @param [Google::Apis::RequestOptions] options
|
|
421
|
+
# Request-specific options
|
|
422
|
+
#
|
|
423
|
+
# @yield [result, err] Result & error if block supplied
|
|
424
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::FirebaseProject] parsed result object
|
|
425
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
426
|
+
#
|
|
427
|
+
# @return [Google::Apis::FirebaseV1beta1::FirebaseProject]
|
|
428
|
+
#
|
|
429
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
430
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
431
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
432
|
+
def patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
433
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
434
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
|
|
435
|
+
command.request_object = firebase_project_object
|
|
436
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
|
|
437
|
+
command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject
|
|
438
|
+
command.params['name'] = name unless name.nil?
|
|
439
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
440
|
+
command.query['fields'] = fields unless fields.nil?
|
|
441
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
442
|
+
execute_or_queue_command(command, &block)
|
|
443
|
+
end
|
|
444
|
+
|
|
445
|
+
# Unlinks the specified FirebaseProject from its Google Analytics account. This
|
|
446
|
+
# call removes the association of the specified `FirebaseProject` with its
|
|
447
|
+
# current Google Analytics property. However, this call does not delete the
|
|
448
|
+
# Google Analytics resources, such as the Google Analytics property or any data
|
|
449
|
+
# streams. These resources may be re-associated later to the `FirebaseProject`
|
|
450
|
+
# by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
|
|
451
|
+
# and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps,
|
|
452
|
+
# this call re-links data streams with their corresponding apps. However, for
|
|
453
|
+
# Web Apps, this call provisions a *new* data stream for each Web App. To call `
|
|
454
|
+
# RemoveAnalytics`, a project member must be an Owner for the `FirebaseProject`.
|
|
455
|
+
# @param [String] parent
|
|
456
|
+
# The resource name of the FirebaseProject to unlink from its Google Analytics
|
|
457
|
+
# account, in the format: projects/PROJECT_IDENTIFIER Refer to the `
|
|
458
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
459
|
+
# details about PROJECT_IDENTIFIER values.
|
|
460
|
+
# @param [Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest] remove_analytics_request_object
|
|
461
|
+
# @param [String] fields
|
|
462
|
+
# Selector specifying which fields to include in a partial response.
|
|
463
|
+
# @param [String] quota_user
|
|
464
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
465
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
466
|
+
# @param [Google::Apis::RequestOptions] options
|
|
467
|
+
# Request-specific options
|
|
468
|
+
#
|
|
469
|
+
# @yield [result, err] Result & error if block supplied
|
|
470
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Empty] parsed result object
|
|
471
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
472
|
+
#
|
|
473
|
+
# @return [Google::Apis::FirebaseV1beta1::Empty]
|
|
474
|
+
#
|
|
475
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
476
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
477
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
478
|
+
def remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
479
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}:removeAnalytics', options)
|
|
480
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest::Representation
|
|
481
|
+
command.request_object = remove_analytics_request_object
|
|
482
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation
|
|
483
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Empty
|
|
484
|
+
command.params['parent'] = parent unless parent.nil?
|
|
485
|
+
command.query['fields'] = fields unless fields.nil?
|
|
486
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
487
|
+
execute_or_queue_command(command, &block)
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
# Lists all available Apps for the specified FirebaseProject. This is a
|
|
491
|
+
# convenience method. Typically, interaction with an App should be done using
|
|
492
|
+
# the platform-specific service, but some tool use-cases require a summary of
|
|
493
|
+
# all known Apps (such as for App selector interfaces).
|
|
494
|
+
# @param [String] parent
|
|
495
|
+
# The parent FirebaseProject for which to list Apps, in the format: projects/
|
|
496
|
+
# PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects#
|
|
497
|
+
# FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
|
|
498
|
+
# @param [String] filter
|
|
499
|
+
# A query string compatible with Google's [AIP-160](https://google.aip.dev/160)
|
|
500
|
+
# standard. Use any of the following fields in a query: * [`app_id`](../projects.
|
|
501
|
+
# apps#FirebaseAppInfo.FIELDS.app_id) * [`namespace`](../projects.apps#
|
|
502
|
+
# FirebaseAppInfo.FIELDS.namespace) * [`platform`](../projects.apps#
|
|
503
|
+
# FirebaseAppInfo.FIELDS.platform) We also support the following "virtual"
|
|
504
|
+
# fields (fields which are not actually part of the returned resource object,
|
|
505
|
+
# but can be queried as if they are pre-populated with specific values): * `
|
|
506
|
+
# sha1_hash`: This field is considered to be a repeated `string` field,
|
|
507
|
+
# populated with the list of all SHA-1 certificate fingerprints registered with
|
|
508
|
+
# the app. This list is empty if the app is not an Android app. * `sha256_hash`:
|
|
509
|
+
# This field is considered to be a repeated `string` field, populated with the
|
|
510
|
+
# list of all SHA-256 certificate fingerprints registered with the app. This
|
|
511
|
+
# list is empty if the app is not an Android app. * `app_store_id`: This field
|
|
512
|
+
# is considered to be a singular `string` field, populated with the Apple App
|
|
513
|
+
# Store ID registered with the app. This field is empty if the app is not an iOS
|
|
514
|
+
# app. * `team_id`: This field is considered to be a singular `string` field,
|
|
515
|
+
# populated with the Apple team ID registered with the app. This field is empty
|
|
516
|
+
# if the app is not an iOS app.
|
|
517
|
+
# @param [Fixnum] page_size
|
|
518
|
+
# The maximum number of Apps to return in the response. The server may return
|
|
519
|
+
# fewer than this value at its discretion. If no value is specified (or too
|
|
520
|
+
# large a value is specified), then the server will impose its own limit. This
|
|
521
|
+
# value cannot be negative.
|
|
522
|
+
# @param [String] page_token
|
|
523
|
+
# Token returned from a previous call to `SearchFirebaseApps` indicating where
|
|
524
|
+
# in the set of Apps to resume listing.
|
|
525
|
+
# @param [String] fields
|
|
526
|
+
# Selector specifying which fields to include in a partial response.
|
|
527
|
+
# @param [String] quota_user
|
|
528
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
529
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
530
|
+
# @param [Google::Apis::RequestOptions] options
|
|
531
|
+
# Request-specific options
|
|
532
|
+
#
|
|
533
|
+
# @yield [result, err] Result & error if block supplied
|
|
534
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse] parsed result object
|
|
535
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
536
|
+
#
|
|
537
|
+
# @return [Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse]
|
|
538
|
+
#
|
|
539
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
540
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
541
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
542
|
+
def search_project_apps(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
543
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}:searchApps', options)
|
|
544
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse::Representation
|
|
545
|
+
command.response_class = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse
|
|
546
|
+
command.params['parent'] = parent unless parent.nil?
|
|
547
|
+
command.query['filter'] = filter unless filter.nil?
|
|
548
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
549
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
550
|
+
command.query['fields'] = fields unless fields.nil?
|
|
551
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
552
|
+
execute_or_queue_command(command, &block)
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
# Requests the creation of a new AndroidApp in the specified FirebaseProject.
|
|
556
|
+
# The result of this call is an `Operation` which can be used to track the
|
|
557
|
+
# provisioning process. The `Operation` is automatically deleted after
|
|
558
|
+
# completion, so there is no need to call `DeleteOperation`.
|
|
559
|
+
# @param [String] parent
|
|
560
|
+
# The resource name of the parent FirebaseProject in which to create an
|
|
561
|
+
# AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to
|
|
562
|
+
# the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field
|
|
563
|
+
# for details about PROJECT_IDENTIFIER values.
|
|
564
|
+
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
|
|
565
|
+
# @param [String] fields
|
|
566
|
+
# Selector specifying which fields to include in a partial response.
|
|
567
|
+
# @param [String] quota_user
|
|
568
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
569
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
570
|
+
# @param [Google::Apis::RequestOptions] options
|
|
571
|
+
# Request-specific options
|
|
572
|
+
#
|
|
573
|
+
# @yield [result, err] Result & error if block supplied
|
|
574
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
575
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
576
|
+
#
|
|
577
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
578
|
+
#
|
|
579
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
580
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
581
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
582
|
+
def create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
583
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/androidApps', options)
|
|
584
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
|
|
585
|
+
command.request_object = android_app_object
|
|
586
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
587
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
588
|
+
command.params['parent'] = parent unless parent.nil?
|
|
589
|
+
command.query['fields'] = fields unless fields.nil?
|
|
590
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
591
|
+
execute_or_queue_command(command, &block)
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
# Gets the specified AndroidApp.
|
|
595
|
+
# @param [String] name
|
|
596
|
+
# The resource name of the AndroidApp, in the format: projects/
|
|
597
|
+
# PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique identifier,
|
|
598
|
+
# the Unique Resource from Sub-Collection access pattern may be used here, in
|
|
599
|
+
# the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp` [`name`](..
|
|
600
|
+
# /projects.androidApps#AndroidApp.FIELDS.name) field for details about
|
|
601
|
+
# PROJECT_IDENTIFIER and APP_ID values.
|
|
602
|
+
# @param [String] fields
|
|
603
|
+
# Selector specifying which fields to include in a partial response.
|
|
604
|
+
# @param [String] quota_user
|
|
605
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
606
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
607
|
+
# @param [Google::Apis::RequestOptions] options
|
|
608
|
+
# Request-specific options
|
|
609
|
+
#
|
|
610
|
+
# @yield [result, err] Result & error if block supplied
|
|
611
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::AndroidApp] parsed result object
|
|
612
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
613
|
+
#
|
|
614
|
+
# @return [Google::Apis::FirebaseV1beta1::AndroidApp]
|
|
615
|
+
#
|
|
616
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
617
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
618
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
619
|
+
def get_project_android_app(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
620
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
621
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
|
|
622
|
+
command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp
|
|
623
|
+
command.params['name'] = name unless name.nil?
|
|
624
|
+
command.query['fields'] = fields unless fields.nil?
|
|
625
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
626
|
+
execute_or_queue_command(command, &block)
|
|
627
|
+
end
|
|
628
|
+
|
|
629
|
+
# Gets the configuration artifact associated with the specified AndroidApp.
|
|
630
|
+
# @param [String] name
|
|
631
|
+
# The resource name of the AndroidApp configuration to download, in the format:
|
|
632
|
+
# projects/PROJECT_IDENTIFIER/androidApps/APP_ID/config Since an APP_ID is a
|
|
633
|
+
# unique identifier, the Unique Resource from Sub-Collection access pattern may
|
|
634
|
+
# be used here, in the format: projects/-/androidApps/APP_ID Refer to the `
|
|
635
|
+
# AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for
|
|
636
|
+
# details about PROJECT_IDENTIFIER and APP_ID values.
|
|
637
|
+
# @param [String] fields
|
|
638
|
+
# Selector specifying which fields to include in a partial response.
|
|
639
|
+
# @param [String] quota_user
|
|
640
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
641
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
642
|
+
# @param [Google::Apis::RequestOptions] options
|
|
643
|
+
# Request-specific options
|
|
644
|
+
#
|
|
645
|
+
# @yield [result, err] Result & error if block supplied
|
|
646
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::AndroidAppConfig] parsed result object
|
|
647
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
648
|
+
#
|
|
649
|
+
# @return [Google::Apis::FirebaseV1beta1::AndroidAppConfig]
|
|
650
|
+
#
|
|
651
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
652
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
653
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
654
|
+
def get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
655
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
656
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::AndroidAppConfig::Representation
|
|
657
|
+
command.response_class = Google::Apis::FirebaseV1beta1::AndroidAppConfig
|
|
658
|
+
command.params['name'] = name unless name.nil?
|
|
659
|
+
command.query['fields'] = fields unless fields.nil?
|
|
660
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
661
|
+
execute_or_queue_command(command, &block)
|
|
662
|
+
end
|
|
663
|
+
|
|
664
|
+
# Lists each AndroidApp associated with the specified FirebaseProject. The
|
|
665
|
+
# elements are returned in no particular order, but will be a consistent view of
|
|
666
|
+
# the Apps when additional requests are made with a `pageToken`.
|
|
667
|
+
# @param [String] parent
|
|
668
|
+
# The resource name of the parent FirebaseProject for which to list each
|
|
669
|
+
# associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps
|
|
670
|
+
# Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.
|
|
671
|
+
# name) field for details about PROJECT_IDENTIFIER values.
|
|
672
|
+
# @param [Fixnum] page_size
|
|
673
|
+
# The maximum number of Apps to return in the response. The server may return
|
|
674
|
+
# fewer than this at its discretion. If no value is specified (or too large a
|
|
675
|
+
# value is specified), then the server will impose its own limit.
|
|
676
|
+
# @param [String] page_token
|
|
677
|
+
# Token returned from a previous call to `ListAndroidApps` indicating where in
|
|
678
|
+
# the set of Apps to resume listing.
|
|
679
|
+
# @param [String] fields
|
|
680
|
+
# Selector specifying which fields to include in a partial response.
|
|
681
|
+
# @param [String] quota_user
|
|
682
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
683
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
684
|
+
# @param [Google::Apis::RequestOptions] options
|
|
685
|
+
# Request-specific options
|
|
686
|
+
#
|
|
687
|
+
# @yield [result, err] Result & error if block supplied
|
|
688
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse] parsed result object
|
|
689
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
690
|
+
#
|
|
691
|
+
# @return [Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse]
|
|
692
|
+
#
|
|
693
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
694
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
695
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
696
|
+
def list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
697
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/androidApps', options)
|
|
698
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse::Representation
|
|
699
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse
|
|
700
|
+
command.params['parent'] = parent unless parent.nil?
|
|
701
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
702
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
703
|
+
command.query['fields'] = fields unless fields.nil?
|
|
704
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
705
|
+
execute_or_queue_command(command, &block)
|
|
706
|
+
end
|
|
707
|
+
|
|
708
|
+
# Updates the attributes of the specified AndroidApp.
|
|
709
|
+
# @param [String] name
|
|
710
|
+
# The resource name of the AndroidApp, in the format: projects/
|
|
711
|
+
# PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project'
|
|
712
|
+
# s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(
|
|
713
|
+
# recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.
|
|
714
|
+
# project_id). Learn more about using project identifiers in Google's [AIP 2510
|
|
715
|
+
# standard](https://google.aip.dev/cloud/2510). Note that the value for
|
|
716
|
+
# PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the
|
|
717
|
+
# globally unique, Firebase-assigned identifier for the App (see [`appId`](../
|
|
718
|
+
# projects.androidApps#AndroidApp.FIELDS.app_id)).
|
|
719
|
+
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
|
|
720
|
+
# @param [String] update_mask
|
|
721
|
+
# Specifies which fields to update. Note that the fields `name`, `app_id`, `
|
|
722
|
+
# project_id`, and `package_name` are all immutable.
|
|
723
|
+
# @param [String] fields
|
|
724
|
+
# Selector specifying which fields to include in a partial response.
|
|
725
|
+
# @param [String] quota_user
|
|
726
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
727
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
728
|
+
# @param [Google::Apis::RequestOptions] options
|
|
729
|
+
# Request-specific options
|
|
730
|
+
#
|
|
731
|
+
# @yield [result, err] Result & error if block supplied
|
|
732
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::AndroidApp] parsed result object
|
|
733
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
734
|
+
#
|
|
735
|
+
# @return [Google::Apis::FirebaseV1beta1::AndroidApp]
|
|
736
|
+
#
|
|
737
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
738
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
739
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
740
|
+
def patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
741
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
742
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
|
|
743
|
+
command.request_object = android_app_object
|
|
744
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
|
|
745
|
+
command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp
|
|
746
|
+
command.params['name'] = name unless name.nil?
|
|
747
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
748
|
+
command.query['fields'] = fields unless fields.nil?
|
|
749
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
750
|
+
execute_or_queue_command(command, &block)
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
# Adds a ShaCertificate to the specified AndroidApp.
|
|
754
|
+
# @param [String] parent
|
|
755
|
+
# The resource name of the parent AndroidApp to which to add a ShaCertificate,
|
|
756
|
+
# in the format: projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since an APP_ID
|
|
757
|
+
# is a unique identifier, the Unique Resource from Sub-Collection access pattern
|
|
758
|
+
# may be used here, in the format: projects/-/androidApps/APP_ID Refer to the `
|
|
759
|
+
# AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for
|
|
760
|
+
# details about PROJECT_IDENTIFIER and APP_ID values.
|
|
761
|
+
# @param [Google::Apis::FirebaseV1beta1::ShaCertificate] sha_certificate_object
|
|
762
|
+
# @param [String] fields
|
|
763
|
+
# Selector specifying which fields to include in a partial response.
|
|
764
|
+
# @param [String] quota_user
|
|
765
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
766
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
767
|
+
# @param [Google::Apis::RequestOptions] options
|
|
768
|
+
# Request-specific options
|
|
769
|
+
#
|
|
770
|
+
# @yield [result, err] Result & error if block supplied
|
|
771
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ShaCertificate] parsed result object
|
|
772
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
773
|
+
#
|
|
774
|
+
# @return [Google::Apis::FirebaseV1beta1::ShaCertificate]
|
|
775
|
+
#
|
|
776
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
777
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
778
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
779
|
+
def create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
780
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/sha', options)
|
|
781
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation
|
|
782
|
+
command.request_object = sha_certificate_object
|
|
783
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation
|
|
784
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ShaCertificate
|
|
785
|
+
command.params['parent'] = parent unless parent.nil?
|
|
786
|
+
command.query['fields'] = fields unless fields.nil?
|
|
787
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
788
|
+
execute_or_queue_command(command, &block)
|
|
789
|
+
end
|
|
790
|
+
|
|
791
|
+
# Removes a ShaCertificate from the specified AndroidApp.
|
|
792
|
+
# @param [String] name
|
|
793
|
+
# The resource name of the ShaCertificate to remove from the parent AndroidApp,
|
|
794
|
+
# in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID /sha/SHA_HASH
|
|
795
|
+
# Refer to the `ShaCertificate` [`name`](../projects.androidApps.sha#
|
|
796
|
+
# ShaCertificate.FIELDS.name) field for details about PROJECT_IDENTIFIER, APP_ID,
|
|
797
|
+
# and SHA_HASH values. You can obtain the full resource name of the `
|
|
798
|
+
# ShaCertificate` from the response of [`ListShaCertificates`](../projects.
|
|
799
|
+
# androidApps.sha/list) or the original [`CreateShaCertificate`](../projects.
|
|
800
|
+
# androidApps.sha/create).
|
|
801
|
+
# @param [String] fields
|
|
802
|
+
# Selector specifying which fields to include in a partial response.
|
|
803
|
+
# @param [String] quota_user
|
|
804
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
805
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
806
|
+
# @param [Google::Apis::RequestOptions] options
|
|
807
|
+
# Request-specific options
|
|
808
|
+
#
|
|
809
|
+
# @yield [result, err] Result & error if block supplied
|
|
810
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Empty] parsed result object
|
|
811
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
812
|
+
#
|
|
813
|
+
# @return [Google::Apis::FirebaseV1beta1::Empty]
|
|
814
|
+
#
|
|
815
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
816
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
817
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
818
|
+
def delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
819
|
+
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
820
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation
|
|
821
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Empty
|
|
822
|
+
command.params['name'] = name unless name.nil?
|
|
823
|
+
command.query['fields'] = fields unless fields.nil?
|
|
824
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
825
|
+
execute_or_queue_command(command, &block)
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
# Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
|
|
829
|
+
# @param [String] parent
|
|
830
|
+
# The resource name of the parent AndroidApp for which to list each associated
|
|
831
|
+
# ShaCertificate, in the format: projects/PROJECT_IDENTIFIER /androidApps/APP_ID
|
|
832
|
+
# Since an APP_ID is a unique identifier, the Unique Resource from Sub-
|
|
833
|
+
# Collection access pattern may be used here, in the format: projects/-/
|
|
834
|
+
# androidApps/APP_ID Refer to the `AndroidApp` [`name`](../projects.androidApps#
|
|
835
|
+
# AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID
|
|
836
|
+
# values.
|
|
837
|
+
# @param [String] fields
|
|
838
|
+
# Selector specifying which fields to include in a partial response.
|
|
839
|
+
# @param [String] quota_user
|
|
840
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
841
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
842
|
+
# @param [Google::Apis::RequestOptions] options
|
|
843
|
+
# Request-specific options
|
|
844
|
+
#
|
|
845
|
+
# @yield [result, err] Result & error if block supplied
|
|
846
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse] parsed result object
|
|
847
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
848
|
+
#
|
|
849
|
+
# @return [Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse]
|
|
850
|
+
#
|
|
851
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
852
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
853
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
854
|
+
def list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil, &block)
|
|
855
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/sha', options)
|
|
856
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse::Representation
|
|
857
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse
|
|
858
|
+
command.params['parent'] = parent unless parent.nil?
|
|
859
|
+
command.query['fields'] = fields unless fields.nil?
|
|
860
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
861
|
+
execute_or_queue_command(command, &block)
|
|
862
|
+
end
|
|
863
|
+
|
|
864
|
+
# Lists the valid Google Cloud Platform (GCP) resource locations for the
|
|
865
|
+
# specified Project (including a FirebaseProject). One of these locations can be
|
|
866
|
+
# selected as the Project's [_default_ GCP resource location](https://firebase.
|
|
867
|
+
# google.com/docs/projects/locations), which is the geographical location where
|
|
868
|
+
# the Project's resources, such as Cloud Firestore, will be provisioned by
|
|
869
|
+
# default. However, if the default GCP resource location has already been set
|
|
870
|
+
# for the Project, then this setting cannot be changed. This call checks for any
|
|
871
|
+
# possible [location restrictions](https://cloud.google.com/resource-manager/
|
|
872
|
+
# docs/organization-policy/defining-locations) for the specified Project and,
|
|
873
|
+
# thus, might return a subset of all possible GCP resource locations. To list
|
|
874
|
+
# all GCP resource locations (regardless of any restrictions), call the endpoint
|
|
875
|
+
# without specifying a unique project identifier (that is, `/v1beta1/`parent=
|
|
876
|
+
# projects/-`/listAvailableLocations`). To call `ListAvailableLocations` with a
|
|
877
|
+
# specified project, a member must be at minimum a Viewer of the Project. Calls
|
|
878
|
+
# without a specified project do not require any specific project permissions.
|
|
879
|
+
# @param [String] parent
|
|
880
|
+
# The FirebaseProject for which to list GCP resource locations, in the format:
|
|
881
|
+
# projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../
|
|
882
|
+
# projects#FirebaseProject.FIELDS.name) field for details about
|
|
883
|
+
# PROJECT_IDENTIFIER values. If no unique project identifier is specified (that
|
|
884
|
+
# is, `projects/-`), the returned list does not take into account org-specific
|
|
885
|
+
# or project-specific location restrictions.
|
|
886
|
+
# @param [Fixnum] page_size
|
|
887
|
+
# The maximum number of locations to return in the response. The server may
|
|
888
|
+
# return fewer than this value at its discretion. If no value is specified (or
|
|
889
|
+
# too large a value is specified), then the server will impose its own limit.
|
|
890
|
+
# This value cannot be negative.
|
|
891
|
+
# @param [String] page_token
|
|
892
|
+
# Token returned from a previous call to `ListAvailableLocations` indicating
|
|
893
|
+
# where in the list of locations to resume listing.
|
|
894
|
+
# @param [String] fields
|
|
895
|
+
# Selector specifying which fields to include in a partial response.
|
|
896
|
+
# @param [String] quota_user
|
|
897
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
898
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
899
|
+
# @param [Google::Apis::RequestOptions] options
|
|
900
|
+
# Request-specific options
|
|
901
|
+
#
|
|
902
|
+
# @yield [result, err] Result & error if block supplied
|
|
903
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse] parsed result object
|
|
904
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
905
|
+
#
|
|
906
|
+
# @return [Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse]
|
|
907
|
+
#
|
|
908
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
909
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
910
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
911
|
+
def list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
912
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/availableLocations', options)
|
|
913
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse::Representation
|
|
914
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse
|
|
915
|
+
command.params['parent'] = parent unless parent.nil?
|
|
916
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
917
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
918
|
+
command.query['fields'] = fields unless fields.nil?
|
|
919
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
920
|
+
execute_or_queue_command(command, &block)
|
|
921
|
+
end
|
|
922
|
+
|
|
923
|
+
# Sets the default Google Cloud Platform (GCP) resource location for the
|
|
924
|
+
# specified FirebaseProject. This method creates an App Engine application with
|
|
925
|
+
# a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/
|
|
926
|
+
# standard/python/googlecloudstorageclient/setting-up-cloud-storage#
|
|
927
|
+
# activating_a_cloud_storage_bucket), located in the specified [`locationId`](#
|
|
928
|
+
# body.request_body.FIELDS.location_id). This location must be one of the
|
|
929
|
+
# available [GCP resource locations](https://firebase.google.com/docs/projects/
|
|
930
|
+
# locations). After the default GCP resource location is finalized, or if it was
|
|
931
|
+
# already set, it cannot be changed. The default GCP resource location for the
|
|
932
|
+
# specified `FirebaseProject` might already be set because either the underlying
|
|
933
|
+
# GCP `Project` already has an App Engine application or `
|
|
934
|
+
# FinalizeDefaultLocation` was previously called with a specified `locationId`.
|
|
935
|
+
# Any new calls to `FinalizeDefaultLocation` with a *different* specified `
|
|
936
|
+
# locationId` will return a 409 error. The result of this call is an [`Operation`
|
|
937
|
+
# ](../../v1beta1/operations), which can be used to track the provisioning
|
|
938
|
+
# process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response)
|
|
939
|
+
# type of the `Operation` is google.protobuf.Empty. The `Operation` can be
|
|
940
|
+
# polled by its `name` using GetOperation until `done` is true. When `done` is
|
|
941
|
+
# true, the `Operation` has either succeeded or failed. If the `Operation` has
|
|
942
|
+
# succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response)
|
|
943
|
+
# will be set to a google.protobuf.Empty; if the `Operation` has failed, its `
|
|
944
|
+
# error` will be set to a google.rpc.Status. The `Operation` is automatically
|
|
945
|
+
# deleted after completion, so there is no need to call DeleteOperation. All
|
|
946
|
+
# fields listed in the [request body](#request-body) are required. To call `
|
|
947
|
+
# FinalizeDefaultLocation`, a member must be an Owner of the Project.
|
|
948
|
+
# @param [String] parent
|
|
949
|
+
# The resource name of the FirebaseProject for which the default GCP resource
|
|
950
|
+
# location will be set, in the format: projects/PROJECT_IDENTIFIER Refer to the `
|
|
951
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
952
|
+
# details about PROJECT_IDENTIFIER values.
|
|
953
|
+
# @param [Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest] finalize_default_location_request_object
|
|
954
|
+
# @param [String] fields
|
|
955
|
+
# Selector specifying which fields to include in a partial response.
|
|
956
|
+
# @param [String] quota_user
|
|
957
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
958
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
959
|
+
# @param [Google::Apis::RequestOptions] options
|
|
960
|
+
# Request-specific options
|
|
961
|
+
#
|
|
962
|
+
# @yield [result, err] Result & error if block supplied
|
|
963
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
964
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
965
|
+
#
|
|
966
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
967
|
+
#
|
|
968
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
969
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
970
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
971
|
+
def finalize_default_location(parent, finalize_default_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
972
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/defaultLocation:finalize', options)
|
|
973
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest::Representation
|
|
974
|
+
command.request_object = finalize_default_location_request_object
|
|
975
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
976
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
977
|
+
command.params['parent'] = parent unless parent.nil?
|
|
978
|
+
command.query['fields'] = fields unless fields.nil?
|
|
979
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
980
|
+
execute_or_queue_command(command, &block)
|
|
981
|
+
end
|
|
982
|
+
|
|
983
|
+
# Requests the creation of a new IosApp in the specified FirebaseProject. The
|
|
984
|
+
# result of this call is an `Operation` which can be used to track the
|
|
985
|
+
# provisioning process. The `Operation` is automatically deleted after
|
|
986
|
+
# completion, so there is no need to call `DeleteOperation`.
|
|
987
|
+
# @param [String] parent
|
|
988
|
+
# The resource name of the parent FirebaseProject in which to create an IosApp,
|
|
989
|
+
# in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the `
|
|
990
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
991
|
+
# details about PROJECT_IDENTIFIER values.
|
|
992
|
+
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
|
|
993
|
+
# @param [String] fields
|
|
994
|
+
# Selector specifying which fields to include in a partial response.
|
|
995
|
+
# @param [String] quota_user
|
|
996
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
997
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
998
|
+
# @param [Google::Apis::RequestOptions] options
|
|
999
|
+
# Request-specific options
|
|
1000
|
+
#
|
|
1001
|
+
# @yield [result, err] Result & error if block supplied
|
|
1002
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
1003
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1004
|
+
#
|
|
1005
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
1006
|
+
#
|
|
1007
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1008
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1009
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1010
|
+
def create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1011
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/iosApps', options)
|
|
1012
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
|
|
1013
|
+
command.request_object = ios_app_object
|
|
1014
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
1015
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
1016
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1017
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1018
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1019
|
+
execute_or_queue_command(command, &block)
|
|
1020
|
+
end
|
|
1021
|
+
|
|
1022
|
+
# Gets the specified IosApp.
|
|
1023
|
+
# @param [String] name
|
|
1024
|
+
# The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /
|
|
1025
|
+
# iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource
|
|
1026
|
+
# from Sub-Collection access pattern may be used here, in the format: projects/-/
|
|
1027
|
+
# iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp.
|
|
1028
|
+
# FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
1029
|
+
# @param [String] fields
|
|
1030
|
+
# Selector specifying which fields to include in a partial response.
|
|
1031
|
+
# @param [String] quota_user
|
|
1032
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1033
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1034
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1035
|
+
# Request-specific options
|
|
1036
|
+
#
|
|
1037
|
+
# @yield [result, err] Result & error if block supplied
|
|
1038
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::IosApp] parsed result object
|
|
1039
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1040
|
+
#
|
|
1041
|
+
# @return [Google::Apis::FirebaseV1beta1::IosApp]
|
|
1042
|
+
#
|
|
1043
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1044
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1045
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1046
|
+
def get_project_ios_app(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1047
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
1048
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
|
|
1049
|
+
command.response_class = Google::Apis::FirebaseV1beta1::IosApp
|
|
1050
|
+
command.params['name'] = name unless name.nil?
|
|
1051
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1052
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1053
|
+
execute_or_queue_command(command, &block)
|
|
1054
|
+
end
|
|
1055
|
+
|
|
1056
|
+
# Gets the configuration artifact associated with the specified IosApp.
|
|
1057
|
+
# @param [String] name
|
|
1058
|
+
# The resource name of the App configuration to download, in the format:
|
|
1059
|
+
# projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique
|
|
1060
|
+
# identifier, the Unique Resource from Sub-Collection access pattern may be used
|
|
1061
|
+
# here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](.
|
|
1062
|
+
# ./projects.iosApps#IosApp.FIELDS.name) field for details about
|
|
1063
|
+
# PROJECT_IDENTIFIER and APP_ID values.
|
|
1064
|
+
# @param [String] fields
|
|
1065
|
+
# Selector specifying which fields to include in a partial response.
|
|
1066
|
+
# @param [String] quota_user
|
|
1067
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1068
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1069
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1070
|
+
# Request-specific options
|
|
1071
|
+
#
|
|
1072
|
+
# @yield [result, err] Result & error if block supplied
|
|
1073
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::IosAppConfig] parsed result object
|
|
1074
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1075
|
+
#
|
|
1076
|
+
# @return [Google::Apis::FirebaseV1beta1::IosAppConfig]
|
|
1077
|
+
#
|
|
1078
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1079
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1080
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1081
|
+
def get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1082
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
1083
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::IosAppConfig::Representation
|
|
1084
|
+
command.response_class = Google::Apis::FirebaseV1beta1::IosAppConfig
|
|
1085
|
+
command.params['name'] = name unless name.nil?
|
|
1086
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1087
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1088
|
+
execute_or_queue_command(command, &block)
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
# Lists each IosApp associated with the specified FirebaseProject. The elements
|
|
1092
|
+
# are returned in no particular order, but will be a consistent view of the Apps
|
|
1093
|
+
# when additional requests are made with a `pageToken`.
|
|
1094
|
+
# @param [String] parent
|
|
1095
|
+
# The resource name of the parent FirebaseProject for which to list each
|
|
1096
|
+
# associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to
|
|
1097
|
+
# the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field
|
|
1098
|
+
# for details about PROJECT_IDENTIFIER values.
|
|
1099
|
+
# @param [Fixnum] page_size
|
|
1100
|
+
# The maximum number of Apps to return in the response. The server may return
|
|
1101
|
+
# fewer than this at its discretion. If no value is specified (or too large a
|
|
1102
|
+
# value is specified), the server will impose its own limit.
|
|
1103
|
+
# @param [String] page_token
|
|
1104
|
+
# Token returned from a previous call to `ListIosApps` indicating where in the
|
|
1105
|
+
# set of Apps to resume listing.
|
|
1106
|
+
# @param [String] fields
|
|
1107
|
+
# Selector specifying which fields to include in a partial response.
|
|
1108
|
+
# @param [String] quota_user
|
|
1109
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1110
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1111
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1112
|
+
# Request-specific options
|
|
1113
|
+
#
|
|
1114
|
+
# @yield [result, err] Result & error if block supplied
|
|
1115
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListIosAppsResponse] parsed result object
|
|
1116
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1117
|
+
#
|
|
1118
|
+
# @return [Google::Apis::FirebaseV1beta1::ListIosAppsResponse]
|
|
1119
|
+
#
|
|
1120
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1121
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1122
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1123
|
+
def list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1124
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/iosApps', options)
|
|
1125
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListIosAppsResponse::Representation
|
|
1126
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListIosAppsResponse
|
|
1127
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1128
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1129
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1130
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1131
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1132
|
+
execute_or_queue_command(command, &block)
|
|
1133
|
+
end
|
|
1134
|
+
|
|
1135
|
+
# Updates the attributes of the specified IosApp.
|
|
1136
|
+
# @param [String] name
|
|
1137
|
+
# The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /
|
|
1138
|
+
# iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../
|
|
1139
|
+
# projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`
|
|
1140
|
+
# ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1141
|
+
# using project identifiers in Google's [AIP 2510 standard](https://google.aip.
|
|
1142
|
+
# dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response
|
|
1143
|
+
# body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned
|
|
1144
|
+
# identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)
|
|
1145
|
+
# ).
|
|
1146
|
+
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
|
|
1147
|
+
# @param [String] update_mask
|
|
1148
|
+
# Specifies which fields to update. Note that the fields `name`, `appId`, `
|
|
1149
|
+
# projectId`, and `bundleId` are all immutable.
|
|
1150
|
+
# @param [String] fields
|
|
1151
|
+
# Selector specifying which fields to include in a partial response.
|
|
1152
|
+
# @param [String] quota_user
|
|
1153
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1154
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1155
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1156
|
+
# Request-specific options
|
|
1157
|
+
#
|
|
1158
|
+
# @yield [result, err] Result & error if block supplied
|
|
1159
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::IosApp] parsed result object
|
|
1160
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1161
|
+
#
|
|
1162
|
+
# @return [Google::Apis::FirebaseV1beta1::IosApp]
|
|
1163
|
+
#
|
|
1164
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1165
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1166
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1167
|
+
def patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1168
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
1169
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
|
|
1170
|
+
command.request_object = ios_app_object
|
|
1171
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
|
|
1172
|
+
command.response_class = Google::Apis::FirebaseV1beta1::IosApp
|
|
1173
|
+
command.params['name'] = name unless name.nil?
|
|
1174
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1175
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1176
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1177
|
+
execute_or_queue_command(command, &block)
|
|
1178
|
+
end
|
|
1179
|
+
|
|
1180
|
+
# Requests the creation of a new WebApp in the specified FirebaseProject. The
|
|
1181
|
+
# result of this call is an `Operation` which can be used to track the
|
|
1182
|
+
# provisioning process. The `Operation` is automatically deleted after
|
|
1183
|
+
# completion, so there is no need to call `DeleteOperation`.
|
|
1184
|
+
# @param [String] parent
|
|
1185
|
+
# The resource name of the parent FirebaseProject in which to create a WebApp,
|
|
1186
|
+
# in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the `
|
|
1187
|
+
# FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
|
1188
|
+
# details about PROJECT_IDENTIFIER values.
|
|
1189
|
+
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
|
|
1190
|
+
# @param [String] fields
|
|
1191
|
+
# Selector specifying which fields to include in a partial response.
|
|
1192
|
+
# @param [String] quota_user
|
|
1193
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1194
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1195
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1196
|
+
# Request-specific options
|
|
1197
|
+
#
|
|
1198
|
+
# @yield [result, err] Result & error if block supplied
|
|
1199
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::Operation] parsed result object
|
|
1200
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1201
|
+
#
|
|
1202
|
+
# @return [Google::Apis::FirebaseV1beta1::Operation]
|
|
1203
|
+
#
|
|
1204
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1205
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1206
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1207
|
+
def create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1208
|
+
command = make_simple_command(:post, 'v1beta1/{+parent}/webApps', options)
|
|
1209
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
|
|
1210
|
+
command.request_object = web_app_object
|
|
1211
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
|
|
1212
|
+
command.response_class = Google::Apis::FirebaseV1beta1::Operation
|
|
1213
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1214
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1215
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1216
|
+
execute_or_queue_command(command, &block)
|
|
1217
|
+
end
|
|
1218
|
+
|
|
1219
|
+
# Gets the specified WebApp.
|
|
1220
|
+
# @param [String] name
|
|
1221
|
+
# The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /
|
|
1222
|
+
# webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource
|
|
1223
|
+
# from Sub-Collection access pattern may be used here, in the format: projects/-/
|
|
1224
|
+
# webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp.
|
|
1225
|
+
# FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
1226
|
+
# @param [String] fields
|
|
1227
|
+
# Selector specifying which fields to include in a partial response.
|
|
1228
|
+
# @param [String] quota_user
|
|
1229
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1230
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1231
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1232
|
+
# Request-specific options
|
|
1233
|
+
#
|
|
1234
|
+
# @yield [result, err] Result & error if block supplied
|
|
1235
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::WebApp] parsed result object
|
|
1236
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1237
|
+
#
|
|
1238
|
+
# @return [Google::Apis::FirebaseV1beta1::WebApp]
|
|
1239
|
+
#
|
|
1240
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1241
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1242
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1243
|
+
def get_project_web_app(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1244
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
1245
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
|
|
1246
|
+
command.response_class = Google::Apis::FirebaseV1beta1::WebApp
|
|
1247
|
+
command.params['name'] = name unless name.nil?
|
|
1248
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1249
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1250
|
+
execute_or_queue_command(command, &block)
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
# Gets the configuration artifact associated with the specified WebApp.
|
|
1254
|
+
# @param [String] name
|
|
1255
|
+
# The resource name of the WebApp configuration to download, in the format:
|
|
1256
|
+
# projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since an APP_ID is a unique
|
|
1257
|
+
# identifier, the Unique Resource from Sub-Collection access pattern may be used
|
|
1258
|
+
# here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](.
|
|
1259
|
+
# ./projects.webApps#WebApp.FIELDS.name) field for details about
|
|
1260
|
+
# PROJECT_IDENTIFIER and APP_ID values.
|
|
1261
|
+
# @param [String] fields
|
|
1262
|
+
# Selector specifying which fields to include in a partial response.
|
|
1263
|
+
# @param [String] quota_user
|
|
1264
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1265
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1266
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1267
|
+
# Request-specific options
|
|
1268
|
+
#
|
|
1269
|
+
# @yield [result, err] Result & error if block supplied
|
|
1270
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::WebAppConfig] parsed result object
|
|
1271
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1272
|
+
#
|
|
1273
|
+
# @return [Google::Apis::FirebaseV1beta1::WebAppConfig]
|
|
1274
|
+
#
|
|
1275
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1276
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1277
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1278
|
+
def get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
|
1279
|
+
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
1280
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::WebAppConfig::Representation
|
|
1281
|
+
command.response_class = Google::Apis::FirebaseV1beta1::WebAppConfig
|
|
1282
|
+
command.params['name'] = name unless name.nil?
|
|
1283
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1284
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1285
|
+
execute_or_queue_command(command, &block)
|
|
1286
|
+
end
|
|
1287
|
+
|
|
1288
|
+
# Lists each WebApp associated with the specified FirebaseProject. The elements
|
|
1289
|
+
# are returned in no particular order, but will be a consistent view of the Apps
|
|
1290
|
+
# when additional requests are made with a `pageToken`.
|
|
1291
|
+
# @param [String] parent
|
|
1292
|
+
# The resource name of the parent FirebaseProject for which to list each
|
|
1293
|
+
# associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to
|
|
1294
|
+
# the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field
|
|
1295
|
+
# for details about PROJECT_IDENTIFIER values.
|
|
1296
|
+
# @param [Fixnum] page_size
|
|
1297
|
+
# The maximum number of Apps to return in the response. The server may return
|
|
1298
|
+
# fewer than this value at its discretion. If no value is specified (or too
|
|
1299
|
+
# large a value is specified), then the server will impose its own limit.
|
|
1300
|
+
# @param [String] page_token
|
|
1301
|
+
# Token returned from a previous call to `ListWebApps` indicating where in the
|
|
1302
|
+
# set of Apps to resume listing.
|
|
1303
|
+
# @param [String] fields
|
|
1304
|
+
# Selector specifying which fields to include in a partial response.
|
|
1305
|
+
# @param [String] quota_user
|
|
1306
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1307
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1308
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1309
|
+
# Request-specific options
|
|
1310
|
+
#
|
|
1311
|
+
# @yield [result, err] Result & error if block supplied
|
|
1312
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::ListWebAppsResponse] parsed result object
|
|
1313
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1314
|
+
#
|
|
1315
|
+
# @return [Google::Apis::FirebaseV1beta1::ListWebAppsResponse]
|
|
1316
|
+
#
|
|
1317
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1318
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1319
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1320
|
+
def list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1321
|
+
command = make_simple_command(:get, 'v1beta1/{+parent}/webApps', options)
|
|
1322
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::ListWebAppsResponse::Representation
|
|
1323
|
+
command.response_class = Google::Apis::FirebaseV1beta1::ListWebAppsResponse
|
|
1324
|
+
command.params['parent'] = parent unless parent.nil?
|
|
1325
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
|
1326
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
|
1327
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1328
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1329
|
+
execute_or_queue_command(command, &block)
|
|
1330
|
+
end
|
|
1331
|
+
|
|
1332
|
+
# Updates the attributes of the specified WebApp.
|
|
1333
|
+
# @param [String] name
|
|
1334
|
+
# The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /
|
|
1335
|
+
# webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../
|
|
1336
|
+
# projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`
|
|
1337
|
+
# ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about
|
|
1338
|
+
# using project identifiers in Google's [AIP 2510 standard](https://google.aip.
|
|
1339
|
+
# dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response
|
|
1340
|
+
# body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned
|
|
1341
|
+
# identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)
|
|
1342
|
+
# ).
|
|
1343
|
+
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
|
|
1344
|
+
# @param [String] update_mask
|
|
1345
|
+
# Specifies which fields to update. Note that the fields `name`, `appId`, and `
|
|
1346
|
+
# projectId` are all immutable.
|
|
1347
|
+
# @param [String] fields
|
|
1348
|
+
# Selector specifying which fields to include in a partial response.
|
|
1349
|
+
# @param [String] quota_user
|
|
1350
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
|
1351
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
1352
|
+
# @param [Google::Apis::RequestOptions] options
|
|
1353
|
+
# Request-specific options
|
|
1354
|
+
#
|
|
1355
|
+
# @yield [result, err] Result & error if block supplied
|
|
1356
|
+
# @yieldparam result [Google::Apis::FirebaseV1beta1::WebApp] parsed result object
|
|
1357
|
+
# @yieldparam err [StandardError] error object if request failed
|
|
1358
|
+
#
|
|
1359
|
+
# @return [Google::Apis::FirebaseV1beta1::WebApp]
|
|
1360
|
+
#
|
|
1361
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
1362
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
1363
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
1364
|
+
def patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
1365
|
+
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
1366
|
+
command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
|
|
1367
|
+
command.request_object = web_app_object
|
|
1368
|
+
command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
|
|
1369
|
+
command.response_class = Google::Apis::FirebaseV1beta1::WebApp
|
|
1370
|
+
command.params['name'] = name unless name.nil?
|
|
1371
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
|
1372
|
+
command.query['fields'] = fields unless fields.nil?
|
|
1373
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1374
|
+
execute_or_queue_command(command, &block)
|
|
1375
|
+
end
|
|
1376
|
+
|
|
1377
|
+
protected
|
|
1378
|
+
|
|
1379
|
+
def apply_command_defaults(command)
|
|
1380
|
+
command.query['key'] = key unless key.nil?
|
|
1381
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
1382
|
+
end
|
|
1383
|
+
end
|
|
1384
|
+
end
|
|
1385
|
+
end
|
|
1386
|
+
end
|