google-apis-firebaseapphosting_v1 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1198 @@
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 FirebaseapphostingV1
23
+ # Firebase App Hosting API
24
+ #
25
+ # Firebase App Hosting streamlines the development and deployment of dynamic
26
+ # Next.js and Angular applications, offering built-in framework support, GitHub
27
+ # integration, and integration with other Firebase products. You can use this
28
+ # API to intervene in the Firebase App Hosting build process and add custom
29
+ # functionality not supported in our default Console & CLI flows, including
30
+ # triggering builds from external CI/CD workflows or deploying from pre-built
31
+ # container images.
32
+ #
33
+ # @example
34
+ # require 'google/apis/firebaseapphosting_v1'
35
+ #
36
+ # Firebaseapphosting = Google::Apis::FirebaseapphostingV1 # Alias the module
37
+ # service = Firebaseapphosting::FirebaseAppHostingService.new
38
+ #
39
+ # @see https://firebase.google.com/docs/app-hosting
40
+ class FirebaseAppHostingService < Google::Apis::Core::BaseService
41
+ DEFAULT_ENDPOINT_TEMPLATE = "https://firebaseapphosting.$UNIVERSE_DOMAIN$/"
42
+
43
+ # @return [String]
44
+ # API key. Your API key identifies your project and provides you with API access,
45
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
46
+ attr_accessor :key
47
+
48
+ # @return [String]
49
+ # Available to use for quota purposes for server-side applications. Can be any
50
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
51
+ attr_accessor :quota_user
52
+
53
+ def initialize
54
+ super(DEFAULT_ENDPOINT_TEMPLATE, '',
55
+ client_name: 'google-apis-firebaseapphosting_v1',
56
+ client_version: Google::Apis::FirebaseapphostingV1::GEM_VERSION)
57
+ @batch_path = 'batch'
58
+ end
59
+
60
+ # Gets information about a location.
61
+ # @param [String] name
62
+ # Resource name for the location.
63
+ # @param [String] fields
64
+ # Selector specifying which fields to include in a partial response.
65
+ # @param [String] quota_user
66
+ # Available to use for quota purposes for server-side applications. Can be any
67
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
68
+ # @param [Google::Apis::RequestOptions] options
69
+ # Request-specific options
70
+ #
71
+ # @yield [result, err] Result & error if block supplied
72
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Location] parsed result object
73
+ # @yieldparam err [StandardError] error object if request failed
74
+ #
75
+ # @return [Google::Apis::FirebaseapphostingV1::Location]
76
+ #
77
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
78
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
79
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
80
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
81
+ command = make_simple_command(:get, 'v1/{+name}', options)
82
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Location::Representation
83
+ command.response_class = Google::Apis::FirebaseapphostingV1::Location
84
+ command.params['name'] = name unless name.nil?
85
+ command.query['fields'] = fields unless fields.nil?
86
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
87
+ execute_or_queue_command(command, &block)
88
+ end
89
+
90
+ # Lists information about the supported locations for this service.
91
+ # @param [String] name
92
+ # The resource that owns the locations collection, if applicable.
93
+ # @param [Array<String>, String] extra_location_types
94
+ # Optional. A list of extra location types that should be used as conditions for
95
+ # controlling the visibility of the locations.
96
+ # @param [String] filter
97
+ # A filter to narrow down results to a preferred subset. The filtering language
98
+ # accepts strings like `"displayName=tokyo"`, and is documented in more detail
99
+ # in [AIP-160](https://google.aip.dev/160).
100
+ # @param [Fixnum] page_size
101
+ # The maximum number of results to return. If not set, the service selects a
102
+ # default.
103
+ # @param [String] page_token
104
+ # A page token received from the `next_page_token` field in the response. Send
105
+ # that page token to receive the subsequent page.
106
+ # @param [String] fields
107
+ # Selector specifying which fields to include in a partial response.
108
+ # @param [String] quota_user
109
+ # Available to use for quota purposes for server-side applications. Can be any
110
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
111
+ # @param [Google::Apis::RequestOptions] options
112
+ # Request-specific options
113
+ #
114
+ # @yield [result, err] Result & error if block supplied
115
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListLocationsResponse] parsed result object
116
+ # @yieldparam err [StandardError] error object if request failed
117
+ #
118
+ # @return [Google::Apis::FirebaseapphostingV1::ListLocationsResponse]
119
+ #
120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
123
+ def list_project_locations(name, extra_location_types: nil, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
124
+ command = make_simple_command(:get, 'v1/{+name}/locations', options)
125
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListLocationsResponse::Representation
126
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListLocationsResponse
127
+ command.params['name'] = name unless name.nil?
128
+ command.query['extraLocationTypes'] = extra_location_types unless extra_location_types.nil?
129
+ command.query['filter'] = filter unless filter.nil?
130
+ command.query['pageSize'] = page_size unless page_size.nil?
131
+ command.query['pageToken'] = page_token unless page_token.nil?
132
+ command.query['fields'] = fields unless fields.nil?
133
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
134
+ execute_or_queue_command(command, &block)
135
+ end
136
+
137
+ # Creates a new backend in a given project and location.
138
+ # @param [String] parent
139
+ # Required. A parent name of the form `projects/`project`/locations/`locationId``
140
+ # .
141
+ # @param [Google::Apis::FirebaseapphostingV1::Backend] backend_object
142
+ # @param [String] backend_id
143
+ # Required. Id of the backend. Also used as the service ID for Cloud Run, and as
144
+ # part of the default domain name.
145
+ # @param [String] request_id
146
+ # Optional. An optional request ID to identify requests. Specify a unique
147
+ # request ID so that if you must retry your request, the server will know to
148
+ # ignore the request if it has already been completed. The server will guarantee
149
+ # that for at least 60 minutes since the first request. For example, consider a
150
+ # situation where you make an initial request and t he request times out. If you
151
+ # make the request again with the same request ID, the server can check if
152
+ # original operation with the same request ID was received, and if so, will
153
+ # ignore the second request. This prevents clients from accidentally creating
154
+ # duplicate commitments. The request ID must be a valid UUID with the exception
155
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
156
+ # @param [Boolean] validate_only
157
+ # Optional. Indicates that the request should be validated and default values
158
+ # populated, without persisting the request or creating any resources.
159
+ # @param [String] fields
160
+ # Selector specifying which fields to include in a partial response.
161
+ # @param [String] quota_user
162
+ # Available to use for quota purposes for server-side applications. Can be any
163
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
164
+ # @param [Google::Apis::RequestOptions] options
165
+ # Request-specific options
166
+ #
167
+ # @yield [result, err] Result & error if block supplied
168
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
169
+ # @yieldparam err [StandardError] error object if request failed
170
+ #
171
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
172
+ #
173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
176
+ def create_project_location_backend(parent, backend_object = nil, backend_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
177
+ command = make_simple_command(:post, 'v1/{+parent}/backends', options)
178
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Backend::Representation
179
+ command.request_object = backend_object
180
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
181
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
182
+ command.params['parent'] = parent unless parent.nil?
183
+ command.query['backendId'] = backend_id unless backend_id.nil?
184
+ command.query['requestId'] = request_id unless request_id.nil?
185
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
186
+ command.query['fields'] = fields unless fields.nil?
187
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
188
+ execute_or_queue_command(command, &block)
189
+ end
190
+
191
+ # Deletes a single backend.
192
+ # @param [String] name
193
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
194
+ # locationId`/backends/`backendId``.
195
+ # @param [String] etag
196
+ # Optional. If the client provided etag is out of date, delete will be returned
197
+ # FAILED_PRECONDITION error.
198
+ # @param [Boolean] force
199
+ # Optional. If set to true, any resources for this backend will also be deleted.
200
+ # Otherwise, any children resources will block deletion.
201
+ # @param [String] request_id
202
+ # Optional. An optional request ID to identify requests. Specify a unique
203
+ # request ID so that if you must retry your request, the server will know to
204
+ # ignore the request if it has already been completed. The server will guarantee
205
+ # that for at least 60 minutes after the first request. For example, consider a
206
+ # situation where you make an initial request and t he request times out. If you
207
+ # make the request again with the same request ID, the server can check if
208
+ # original operation with the same request ID was received, and if so, will
209
+ # ignore the second request. This prevents clients from accidentally creating
210
+ # duplicate commitments. The request ID must be a valid UUID with the exception
211
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
212
+ # @param [Boolean] validate_only
213
+ # Optional. Indicates that the request should be validated, without persisting
214
+ # the request or updating any resources.
215
+ # @param [String] fields
216
+ # Selector specifying which fields to include in a partial response.
217
+ # @param [String] quota_user
218
+ # Available to use for quota purposes for server-side applications. Can be any
219
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
220
+ # @param [Google::Apis::RequestOptions] options
221
+ # Request-specific options
222
+ #
223
+ # @yield [result, err] Result & error if block supplied
224
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
225
+ # @yieldparam err [StandardError] error object if request failed
226
+ #
227
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
228
+ #
229
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
230
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
231
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
232
+ def delete_project_location_backend(name, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
233
+ command = make_simple_command(:delete, 'v1/{+name}', options)
234
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
235
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
236
+ command.params['name'] = name unless name.nil?
237
+ command.query['etag'] = etag unless etag.nil?
238
+ command.query['force'] = force unless force.nil?
239
+ command.query['requestId'] = request_id unless request_id.nil?
240
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
241
+ command.query['fields'] = fields unless fields.nil?
242
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
243
+ execute_or_queue_command(command, &block)
244
+ end
245
+
246
+ # Gets information about a backend.
247
+ # @param [String] name
248
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
249
+ # locationId`/backends/`backendId``.
250
+ # @param [String] fields
251
+ # Selector specifying which fields to include in a partial response.
252
+ # @param [String] quota_user
253
+ # Available to use for quota purposes for server-side applications. Can be any
254
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
255
+ # @param [Google::Apis::RequestOptions] options
256
+ # Request-specific options
257
+ #
258
+ # @yield [result, err] Result & error if block supplied
259
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Backend] parsed result object
260
+ # @yieldparam err [StandardError] error object if request failed
261
+ #
262
+ # @return [Google::Apis::FirebaseapphostingV1::Backend]
263
+ #
264
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
265
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
266
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
267
+ def get_project_location_backend(name, fields: nil, quota_user: nil, options: nil, &block)
268
+ command = make_simple_command(:get, 'v1/{+name}', options)
269
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Backend::Representation
270
+ command.response_class = Google::Apis::FirebaseapphostingV1::Backend
271
+ command.params['name'] = name unless name.nil?
272
+ command.query['fields'] = fields unless fields.nil?
273
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
274
+ execute_or_queue_command(command, &block)
275
+ end
276
+
277
+ # Lists backends in a given project and location.
278
+ # @param [String] parent
279
+ # Required. A parent name of the form `projects/`project`/locations/`locationId``
280
+ # .
281
+ # @param [String] filter
282
+ # Optional. A filter to narrow down results to a preferred subset. Learn more
283
+ # about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
284
+ # @param [String] order_by
285
+ # Optional. Hint for how to order the results. Supported fields are `name` and `
286
+ # createTime`. To specify descending order, append a `desc` suffix.
287
+ # @param [Fixnum] page_size
288
+ # Optional. The maximum number of results to return. If not set, the service
289
+ # selects a default.
290
+ # @param [String] page_token
291
+ # Optional. A page token received from the nextPageToken field in the response.
292
+ # Send that page token to receive the subsequent page.
293
+ # @param [Boolean] show_deleted
294
+ # Optional. If true, the request returns soft-deleted resources that haven't
295
+ # been fully-deleted yet.
296
+ # @param [String] fields
297
+ # Selector specifying which fields to include in a partial response.
298
+ # @param [String] quota_user
299
+ # Available to use for quota purposes for server-side applications. Can be any
300
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
301
+ # @param [Google::Apis::RequestOptions] options
302
+ # Request-specific options
303
+ #
304
+ # @yield [result, err] Result & error if block supplied
305
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListBackendsResponse] parsed result object
306
+ # @yieldparam err [StandardError] error object if request failed
307
+ #
308
+ # @return [Google::Apis::FirebaseapphostingV1::ListBackendsResponse]
309
+ #
310
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
311
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
312
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
313
+ def list_project_location_backends(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
314
+ command = make_simple_command(:get, 'v1/{+parent}/backends', options)
315
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListBackendsResponse::Representation
316
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListBackendsResponse
317
+ command.params['parent'] = parent unless parent.nil?
318
+ command.query['filter'] = filter unless filter.nil?
319
+ command.query['orderBy'] = order_by unless order_by.nil?
320
+ command.query['pageSize'] = page_size unless page_size.nil?
321
+ command.query['pageToken'] = page_token unless page_token.nil?
322
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
323
+ command.query['fields'] = fields unless fields.nil?
324
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
325
+ execute_or_queue_command(command, &block)
326
+ end
327
+
328
+ # Updates the information for a single backend.
329
+ # @param [String] name
330
+ # Identifier. The resource name of the backend. Format: `projects/`project`/
331
+ # locations/`locationId`/backends/`backendId``.
332
+ # @param [Google::Apis::FirebaseapphostingV1::Backend] backend_object
333
+ # @param [Boolean] allow_missing
334
+ # Optional. If set to true, and the backend is not found, a new backend will be
335
+ # created.
336
+ # @param [String] request_id
337
+ # Optional. An optional request ID to identify requests. Specify a unique
338
+ # request ID so that if you must retry your request, the server will know to
339
+ # ignore the request if it has already been completed. The server will guarantee
340
+ # that for at least 60 minutes since the first request. For example, consider a
341
+ # situation where you make an initial request and t he request times out. If you
342
+ # make the request again with the same request ID, the server can check if
343
+ # original operation with the same request ID was received, and if so, will
344
+ # ignore the second request. This prevents clients from accidentally creating
345
+ # duplicate commitments. The request ID must be a valid UUID with the exception
346
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
347
+ # @param [String] update_mask
348
+ # Optional. Field mask is used to specify the fields to be overwritten in the
349
+ # backend resource by the update. The fields specified in the update_mask are
350
+ # relative to the resource, not the full request. A field will be overwritten if
351
+ # it is in the mask. If the user does not provide a mask then all fields will be
352
+ # overwritten.
353
+ # @param [Boolean] validate_only
354
+ # Optional. Indicates that the request should be validated, without persisting
355
+ # the request or updating any resources.
356
+ # @param [String] fields
357
+ # Selector specifying which fields to include in a partial response.
358
+ # @param [String] quota_user
359
+ # Available to use for quota purposes for server-side applications. Can be any
360
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
361
+ # @param [Google::Apis::RequestOptions] options
362
+ # Request-specific options
363
+ #
364
+ # @yield [result, err] Result & error if block supplied
365
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
366
+ # @yieldparam err [StandardError] error object if request failed
367
+ #
368
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
369
+ #
370
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
371
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
372
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
373
+ def patch_project_location_backend(name, backend_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
374
+ command = make_simple_command(:patch, 'v1/{+name}', options)
375
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Backend::Representation
376
+ command.request_object = backend_object
377
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
378
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
379
+ command.params['name'] = name unless name.nil?
380
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
381
+ command.query['requestId'] = request_id unless request_id.nil?
382
+ command.query['updateMask'] = update_mask unless update_mask.nil?
383
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
384
+ command.query['fields'] = fields unless fields.nil?
385
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
386
+ execute_or_queue_command(command, &block)
387
+ end
388
+
389
+ # Creates a new build for a backend.
390
+ # @param [String] parent
391
+ # Required. The parent backend in the format: `projects/`project`/locations/`
392
+ # locationId`/backends/`backendId``.
393
+ # @param [Google::Apis::FirebaseapphostingV1::Build] build_object
394
+ # @param [String] build_id
395
+ # Required. Desired ID of the build being created.
396
+ # @param [String] request_id
397
+ # Optional. An optional request ID to identify requests. Specify a unique
398
+ # request ID so that if you must retry your request, the server will know to
399
+ # ignore the request if it has already been completed. The server will guarantee
400
+ # that for at least 60 minutes since the first request. For example, consider a
401
+ # situation where you make an initial request and the request times out. If you
402
+ # make the request again with the same request ID, the server can check if
403
+ # original operation with the same request ID was received, and if so, will
404
+ # ignore the second request. This prevents clients from accidentally creating
405
+ # duplicate commitments. The request ID must be a valid UUID with the exception
406
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
407
+ # @param [Boolean] validate_only
408
+ # Optional. Indicates that the request should be validated and default values
409
+ # populated, without persisting the request or creating any resources.
410
+ # @param [String] fields
411
+ # Selector specifying which fields to include in a partial response.
412
+ # @param [String] quota_user
413
+ # Available to use for quota purposes for server-side applications. Can be any
414
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
415
+ # @param [Google::Apis::RequestOptions] options
416
+ # Request-specific options
417
+ #
418
+ # @yield [result, err] Result & error if block supplied
419
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
420
+ # @yieldparam err [StandardError] error object if request failed
421
+ #
422
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
423
+ #
424
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
425
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
426
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
427
+ def create_project_location_backend_build(parent, build_object = nil, build_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
428
+ command = make_simple_command(:post, 'v1/{+parent}/builds', options)
429
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Build::Representation
430
+ command.request_object = build_object
431
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
432
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
433
+ command.params['parent'] = parent unless parent.nil?
434
+ command.query['buildId'] = build_id unless build_id.nil?
435
+ command.query['requestId'] = request_id unless request_id.nil?
436
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
437
+ command.query['fields'] = fields unless fields.nil?
438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
439
+ execute_or_queue_command(command, &block)
440
+ end
441
+
442
+ # Deletes a single build.
443
+ # @param [String] name
444
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
445
+ # locationId`/backends/`backendId`/builds/`buildId``.
446
+ # @param [String] etag
447
+ # Optional. If the client provided etag is out of date, delete will be returned
448
+ # FAILED_PRECONDITION error.
449
+ # @param [String] request_id
450
+ # Optional. An optional request ID to identify requests. Specify a unique
451
+ # request ID so that if you must retry your request, the server will know to
452
+ # ignore the request if it has already been completed. The server will guarantee
453
+ # that for at least 60 minutes after the first request. For example, consider a
454
+ # situation where you make an initial request and the request times out. If you
455
+ # make the request again with the same request ID, the server can check if
456
+ # original operation with the same request ID was received, and if so, will
457
+ # ignore the second request. This prevents clients from accidentally creating
458
+ # duplicate commitments. The request ID must be a valid UUID with the exception
459
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
460
+ # @param [Boolean] validate_only
461
+ # Optional. Indicates that the request should be validated and default values
462
+ # populated, without persisting the request or deleting any resources.
463
+ # @param [String] fields
464
+ # Selector specifying which fields to include in a partial response.
465
+ # @param [String] quota_user
466
+ # Available to use for quota purposes for server-side applications. Can be any
467
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
468
+ # @param [Google::Apis::RequestOptions] options
469
+ # Request-specific options
470
+ #
471
+ # @yield [result, err] Result & error if block supplied
472
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
473
+ # @yieldparam err [StandardError] error object if request failed
474
+ #
475
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
476
+ #
477
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
478
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
479
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
480
+ def delete_project_location_backend_build(name, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
481
+ command = make_simple_command(:delete, 'v1/{+name}', options)
482
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
483
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
484
+ command.params['name'] = name unless name.nil?
485
+ command.query['etag'] = etag unless etag.nil?
486
+ command.query['requestId'] = request_id unless request_id.nil?
487
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
488
+ command.query['fields'] = fields unless fields.nil?
489
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
490
+ execute_or_queue_command(command, &block)
491
+ end
492
+
493
+ # Gets information about a build.
494
+ # @param [String] name
495
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
496
+ # locationId`/backends/`backendId`/builds/`buildId``.
497
+ # @param [String] fields
498
+ # Selector specifying which fields to include in a partial response.
499
+ # @param [String] quota_user
500
+ # Available to use for quota purposes for server-side applications. Can be any
501
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
502
+ # @param [Google::Apis::RequestOptions] options
503
+ # Request-specific options
504
+ #
505
+ # @yield [result, err] Result & error if block supplied
506
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Build] parsed result object
507
+ # @yieldparam err [StandardError] error object if request failed
508
+ #
509
+ # @return [Google::Apis::FirebaseapphostingV1::Build]
510
+ #
511
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
512
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
513
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
514
+ def get_project_location_backend_build(name, fields: nil, quota_user: nil, options: nil, &block)
515
+ command = make_simple_command(:get, 'v1/{+name}', options)
516
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Build::Representation
517
+ command.response_class = Google::Apis::FirebaseapphostingV1::Build
518
+ command.params['name'] = name unless name.nil?
519
+ command.query['fields'] = fields unless fields.nil?
520
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
521
+ execute_or_queue_command(command, &block)
522
+ end
523
+
524
+ # Lists builds in a given project, location, and backend.
525
+ # @param [String] parent
526
+ # Required. The parent backend in the form `projects/`project`/locations/`
527
+ # locationId`/backends/`backendId``.
528
+ # @param [String] filter
529
+ # Optional. A filter to narrow down results to a preferred subset. Learn more
530
+ # about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
531
+ # @param [String] order_by
532
+ # Optional. Hint for how to order the results. Supported fields are `name` and `
533
+ # createTime`. To specify descending order, append a `desc` suffix.
534
+ # @param [Fixnum] page_size
535
+ # Optional. The maximum number of results to return. If not set, the service
536
+ # selects a default.
537
+ # @param [String] page_token
538
+ # Optional. A page token received from the nextPageToken field in the response.
539
+ # Send that page token to receive the subsequent page.
540
+ # @param [Boolean] show_deleted
541
+ # Optional. If true, the request returns soft-deleted resources that haven't
542
+ # been fully-deleted yet.
543
+ # @param [String] fields
544
+ # Selector specifying which fields to include in a partial response.
545
+ # @param [String] quota_user
546
+ # Available to use for quota purposes for server-side applications. Can be any
547
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
548
+ # @param [Google::Apis::RequestOptions] options
549
+ # Request-specific options
550
+ #
551
+ # @yield [result, err] Result & error if block supplied
552
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListBuildsResponse] parsed result object
553
+ # @yieldparam err [StandardError] error object if request failed
554
+ #
555
+ # @return [Google::Apis::FirebaseapphostingV1::ListBuildsResponse]
556
+ #
557
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
558
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
559
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
560
+ def list_project_location_backend_builds(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
561
+ command = make_simple_command(:get, 'v1/{+parent}/builds', options)
562
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListBuildsResponse::Representation
563
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListBuildsResponse
564
+ command.params['parent'] = parent unless parent.nil?
565
+ command.query['filter'] = filter unless filter.nil?
566
+ command.query['orderBy'] = order_by unless order_by.nil?
567
+ command.query['pageSize'] = page_size unless page_size.nil?
568
+ command.query['pageToken'] = page_token unless page_token.nil?
569
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
570
+ command.query['fields'] = fields unless fields.nil?
571
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
572
+ execute_or_queue_command(command, &block)
573
+ end
574
+
575
+ # Links a new domain to a backend.
576
+ # @param [String] parent
577
+ # Required. The parent backend in the format: `projects/`project`/locations/`
578
+ # locationId`/backends/`backendId``.
579
+ # @param [Google::Apis::FirebaseapphostingV1::Domain] domain_object
580
+ # @param [String] domain_id
581
+ # Required. Id of the domain to create. Must be a valid domain name.
582
+ # @param [String] request_id
583
+ # Optional. An optional request ID to identify requests. Specify a unique
584
+ # request ID so that if you must retry your request, the server will know to
585
+ # ignore the request if it has already been completed. The server will guarantee
586
+ # that for at least 60 minutes since the first request. For example, consider a
587
+ # situation where you make an initial request and the request times out. If you
588
+ # make the request again with the same request ID, the server can check if
589
+ # original operation with the same request ID was received, and if so, will
590
+ # ignore the second request. This prevents clients from accidentally creating
591
+ # duplicate commitments. The request ID must be a valid UUID with the exception
592
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
593
+ # @param [Boolean] validate_only
594
+ # Optional. Indicates that the request should be validated and default values
595
+ # populated, without persisting the request or creating any resources.
596
+ # @param [String] fields
597
+ # Selector specifying which fields to include in a partial response.
598
+ # @param [String] quota_user
599
+ # Available to use for quota purposes for server-side applications. Can be any
600
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
601
+ # @param [Google::Apis::RequestOptions] options
602
+ # Request-specific options
603
+ #
604
+ # @yield [result, err] Result & error if block supplied
605
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
606
+ # @yieldparam err [StandardError] error object if request failed
607
+ #
608
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
609
+ #
610
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
611
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
612
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
613
+ def create_project_location_backend_domain(parent, domain_object = nil, domain_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
614
+ command = make_simple_command(:post, 'v1/{+parent}/domains', options)
615
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Domain::Representation
616
+ command.request_object = domain_object
617
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
618
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
619
+ command.params['parent'] = parent unless parent.nil?
620
+ command.query['domainId'] = domain_id unless domain_id.nil?
621
+ command.query['requestId'] = request_id unless request_id.nil?
622
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
623
+ command.query['fields'] = fields unless fields.nil?
624
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
625
+ execute_or_queue_command(command, &block)
626
+ end
627
+
628
+ # Deletes a single domain.
629
+ # @param [String] name
630
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
631
+ # locationId`/backends/`backendId`/domains/`domainId``.
632
+ # @param [String] etag
633
+ # Optional. If the client provided etag is out of date, delete will be returned
634
+ # FAILED_PRECONDITION error.
635
+ # @param [String] request_id
636
+ # Optional. An optional request ID to identify requests. Specify a unique
637
+ # request ID so that if you must retry your request, the server will know to
638
+ # ignore the request if it has already been completed. The server will guarantee
639
+ # that for at least 60 minutes after the first request. For example, consider a
640
+ # situation where you make an initial request and the request times out. If you
641
+ # make the request again with the same request ID, the server can check if
642
+ # original operation with the same request ID was received, and if so, will
643
+ # ignore the second request. This prevents clients from accidentally creating
644
+ # duplicate commitments. The request ID must be a valid UUID with the exception
645
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
646
+ # @param [Boolean] validate_only
647
+ # Optional. Indicates that the request should be validated and default values
648
+ # populated, without persisting the request or deleting any resources.
649
+ # @param [String] fields
650
+ # Selector specifying which fields to include in a partial response.
651
+ # @param [String] quota_user
652
+ # Available to use for quota purposes for server-side applications. Can be any
653
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
654
+ # @param [Google::Apis::RequestOptions] options
655
+ # Request-specific options
656
+ #
657
+ # @yield [result, err] Result & error if block supplied
658
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
659
+ # @yieldparam err [StandardError] error object if request failed
660
+ #
661
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
662
+ #
663
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
664
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
665
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
666
+ def delete_project_location_backend_domain(name, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
667
+ command = make_simple_command(:delete, 'v1/{+name}', options)
668
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
669
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
670
+ command.params['name'] = name unless name.nil?
671
+ command.query['etag'] = etag unless etag.nil?
672
+ command.query['requestId'] = request_id unless request_id.nil?
673
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
674
+ command.query['fields'] = fields unless fields.nil?
675
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
676
+ execute_or_queue_command(command, &block)
677
+ end
678
+
679
+ # Gets information about a domain.
680
+ # @param [String] name
681
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
682
+ # locationId`/backends/`backendId`/domains/`domainId``.
683
+ # @param [String] fields
684
+ # Selector specifying which fields to include in a partial response.
685
+ # @param [String] quota_user
686
+ # Available to use for quota purposes for server-side applications. Can be any
687
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
688
+ # @param [Google::Apis::RequestOptions] options
689
+ # Request-specific options
690
+ #
691
+ # @yield [result, err] Result & error if block supplied
692
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Domain] parsed result object
693
+ # @yieldparam err [StandardError] error object if request failed
694
+ #
695
+ # @return [Google::Apis::FirebaseapphostingV1::Domain]
696
+ #
697
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
698
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
699
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
700
+ def get_project_location_backend_domain(name, fields: nil, quota_user: nil, options: nil, &block)
701
+ command = make_simple_command(:get, 'v1/{+name}', options)
702
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Domain::Representation
703
+ command.response_class = Google::Apis::FirebaseapphostingV1::Domain
704
+ command.params['name'] = name unless name.nil?
705
+ command.query['fields'] = fields unless fields.nil?
706
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
707
+ execute_or_queue_command(command, &block)
708
+ end
709
+
710
+ # Lists domains of a backend.
711
+ # @param [String] parent
712
+ # Required. The parent backend in the format: `projects/`project`/locations/`
713
+ # locationId`/backends/`backendId``.
714
+ # @param [String] filter
715
+ # Optional. A filter to narrow down results to a preferred subset. Learn more
716
+ # about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
717
+ # @param [String] order_by
718
+ # Optional. Hint for how to order the results. Supported fields are `name` and `
719
+ # createTime`. To specify descending order, append a `desc` suffix.
720
+ # @param [Fixnum] page_size
721
+ # Optional. The maximum number of results to return. If not set, the service
722
+ # selects a default.
723
+ # @param [String] page_token
724
+ # Optional. A page token received from the nextPageToken field in the response.
725
+ # Send that page token to receive the subsequent page.
726
+ # @param [Boolean] show_deleted
727
+ # Optional. If true, the request returns soft-deleted resources that haven't
728
+ # been fully-deleted yet.
729
+ # @param [String] fields
730
+ # Selector specifying which fields to include in a partial response.
731
+ # @param [String] quota_user
732
+ # Available to use for quota purposes for server-side applications. Can be any
733
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
734
+ # @param [Google::Apis::RequestOptions] options
735
+ # Request-specific options
736
+ #
737
+ # @yield [result, err] Result & error if block supplied
738
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListDomainsResponse] parsed result object
739
+ # @yieldparam err [StandardError] error object if request failed
740
+ #
741
+ # @return [Google::Apis::FirebaseapphostingV1::ListDomainsResponse]
742
+ #
743
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
744
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
745
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
746
+ def list_project_location_backend_domains(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
747
+ command = make_simple_command(:get, 'v1/{+parent}/domains', options)
748
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListDomainsResponse::Representation
749
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListDomainsResponse
750
+ command.params['parent'] = parent unless parent.nil?
751
+ command.query['filter'] = filter unless filter.nil?
752
+ command.query['orderBy'] = order_by unless order_by.nil?
753
+ command.query['pageSize'] = page_size unless page_size.nil?
754
+ command.query['pageToken'] = page_token unless page_token.nil?
755
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
756
+ command.query['fields'] = fields unless fields.nil?
757
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
758
+ execute_or_queue_command(command, &block)
759
+ end
760
+
761
+ # Updates the information for a single domain.
762
+ # @param [String] name
763
+ # Identifier. The resource name of the domain, e.g. `/projects/p/locations/l/
764
+ # backends/b/domains/foo.com`
765
+ # @param [Google::Apis::FirebaseapphostingV1::Domain] domain_object
766
+ # @param [Boolean] allow_missing
767
+ # Optional. If set to true, and the domain is not found, a new domain will be
768
+ # created.
769
+ # @param [String] request_id
770
+ # Optional. An optional request ID to identify requests. Specify a unique
771
+ # request ID so that if you must retry your request, the server will know to
772
+ # ignore the request if it has already been completed. The server will guarantee
773
+ # that for at least 60 minutes since the first request. For example, consider a
774
+ # situation where you make an initial request and the request times out. If you
775
+ # make the request again with the same request ID, the server can check if
776
+ # original operation with the same request ID was received, and if so, will
777
+ # ignore the second request. This prevents clients from accidentally creating
778
+ # duplicate commitments. The request ID must be a valid UUID with the exception
779
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
780
+ # @param [String] update_mask
781
+ # Optional. Field mask is used to specify the fields to be overwritten in the
782
+ # Domain resource by the update. The fields specified in the update_mask are
783
+ # relative to the resource, not the full request. A field will be overwritten if
784
+ # it is in the mask. If the user does not provide a mask then all fields will be
785
+ # overwritten.
786
+ # @param [Boolean] validate_only
787
+ # Optional. Indicates that the request should be validated and default values
788
+ # populated, without persisting the request or modifying any resources.
789
+ # @param [String] fields
790
+ # Selector specifying which fields to include in a partial response.
791
+ # @param [String] quota_user
792
+ # Available to use for quota purposes for server-side applications. Can be any
793
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
794
+ # @param [Google::Apis::RequestOptions] options
795
+ # Request-specific options
796
+ #
797
+ # @yield [result, err] Result & error if block supplied
798
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
799
+ # @yieldparam err [StandardError] error object if request failed
800
+ #
801
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
802
+ #
803
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
804
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
805
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
806
+ def patch_project_location_backend_domain(name, domain_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
807
+ command = make_simple_command(:patch, 'v1/{+name}', options)
808
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Domain::Representation
809
+ command.request_object = domain_object
810
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
811
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
812
+ command.params['name'] = name unless name.nil?
813
+ command.query['allowMissing'] = allow_missing unless allow_missing.nil?
814
+ command.query['requestId'] = request_id unless request_id.nil?
815
+ command.query['updateMask'] = update_mask unless update_mask.nil?
816
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
817
+ command.query['fields'] = fields unless fields.nil?
818
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
819
+ execute_or_queue_command(command, &block)
820
+ end
821
+
822
+ # Creates a new rollout for a backend.
823
+ # @param [String] parent
824
+ # Required. The parent backend in the format: `projects/`project`/locations/`
825
+ # locationId`/backends/`backendId``.
826
+ # @param [Google::Apis::FirebaseapphostingV1::Rollout] rollout_object
827
+ # @param [String] request_id
828
+ # Optional. An optional request ID to identify requests. Specify a unique
829
+ # request ID so that if you must retry your request, the server will know to
830
+ # ignore the request if it has already been completed. The server will guarantee
831
+ # that for at least 60 minutes since the first request. For example, consider a
832
+ # situation where you make an initial request and the request times out. If you
833
+ # make the request again with the same request ID, the server can check if
834
+ # original operation with the same request ID was received, and if so, will
835
+ # ignore the second request. This prevents clients from accidentally creating
836
+ # duplicate commitments. The request ID must be a valid UUID with the exception
837
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
838
+ # @param [String] rollout_id
839
+ # Optional. Desired ID of the rollout being created.
840
+ # @param [Boolean] validate_only
841
+ # Optional. Indicates that the request should be validated and default values
842
+ # populated, without persisting the request or creating any resources.
843
+ # @param [String] fields
844
+ # Selector specifying which fields to include in a partial response.
845
+ # @param [String] quota_user
846
+ # Available to use for quota purposes for server-side applications. Can be any
847
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
848
+ # @param [Google::Apis::RequestOptions] options
849
+ # Request-specific options
850
+ #
851
+ # @yield [result, err] Result & error if block supplied
852
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
853
+ # @yieldparam err [StandardError] error object if request failed
854
+ #
855
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
856
+ #
857
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
858
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
859
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
860
+ def create_project_location_backend_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
861
+ command = make_simple_command(:post, 'v1/{+parent}/rollouts', options)
862
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Rollout::Representation
863
+ command.request_object = rollout_object
864
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
865
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
866
+ command.params['parent'] = parent unless parent.nil?
867
+ command.query['requestId'] = request_id unless request_id.nil?
868
+ command.query['rolloutId'] = rollout_id unless rollout_id.nil?
869
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
870
+ command.query['fields'] = fields unless fields.nil?
871
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
872
+ execute_or_queue_command(command, &block)
873
+ end
874
+
875
+ # Gets information about a rollout.
876
+ # @param [String] name
877
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
878
+ # locationId`/backends/`backendId`/rollouts/`rolloutId``.
879
+ # @param [String] fields
880
+ # Selector specifying which fields to include in a partial response.
881
+ # @param [String] quota_user
882
+ # Available to use for quota purposes for server-side applications. Can be any
883
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
884
+ # @param [Google::Apis::RequestOptions] options
885
+ # Request-specific options
886
+ #
887
+ # @yield [result, err] Result & error if block supplied
888
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Rollout] parsed result object
889
+ # @yieldparam err [StandardError] error object if request failed
890
+ #
891
+ # @return [Google::Apis::FirebaseapphostingV1::Rollout]
892
+ #
893
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
894
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
895
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
896
+ def get_project_location_backend_rollout(name, fields: nil, quota_user: nil, options: nil, &block)
897
+ command = make_simple_command(:get, 'v1/{+name}', options)
898
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Rollout::Representation
899
+ command.response_class = Google::Apis::FirebaseapphostingV1::Rollout
900
+ command.params['name'] = name unless name.nil?
901
+ command.query['fields'] = fields unless fields.nil?
902
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
903
+ execute_or_queue_command(command, &block)
904
+ end
905
+
906
+ # Lists rollouts for a backend.
907
+ # @param [String] parent
908
+ # Required. The parent backend in the format: `projects/`project`/locations/`
909
+ # locationId`/backends/`backendId``.
910
+ # @param [String] filter
911
+ # Optional. A filter to narrow down results to a preferred subset. Learn more
912
+ # about filtering in Google's [AIP 160 standard](https://google.aip.dev/160).
913
+ # @param [String] order_by
914
+ # Optional. Hint for how to order the results. Supported fields are `name` and `
915
+ # createTime`. To specify descending order, append a `desc` suffix.
916
+ # @param [Fixnum] page_size
917
+ # Optional. The maximum number of results to return. If not set, the service
918
+ # selects a default.
919
+ # @param [String] page_token
920
+ # Optional. A page token received from the nextPageToken field in the response.
921
+ # Send that page token to receive the subsequent page.
922
+ # @param [Boolean] show_deleted
923
+ # Optional. If true, the request returns soft-deleted resources that haven't
924
+ # been fully-deleted yet.
925
+ # @param [String] fields
926
+ # Selector specifying which fields to include in a partial response.
927
+ # @param [String] quota_user
928
+ # Available to use for quota purposes for server-side applications. Can be any
929
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
930
+ # @param [Google::Apis::RequestOptions] options
931
+ # Request-specific options
932
+ #
933
+ # @yield [result, err] Result & error if block supplied
934
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListRolloutsResponse] parsed result object
935
+ # @yieldparam err [StandardError] error object if request failed
936
+ #
937
+ # @return [Google::Apis::FirebaseapphostingV1::ListRolloutsResponse]
938
+ #
939
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
940
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
941
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
942
+ def list_project_location_backend_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
943
+ command = make_simple_command(:get, 'v1/{+parent}/rollouts', options)
944
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListRolloutsResponse::Representation
945
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListRolloutsResponse
946
+ command.params['parent'] = parent unless parent.nil?
947
+ command.query['filter'] = filter unless filter.nil?
948
+ command.query['orderBy'] = order_by unless order_by.nil?
949
+ command.query['pageSize'] = page_size unless page_size.nil?
950
+ command.query['pageToken'] = page_token unless page_token.nil?
951
+ command.query['showDeleted'] = show_deleted unless show_deleted.nil?
952
+ command.query['fields'] = fields unless fields.nil?
953
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
954
+ execute_or_queue_command(command, &block)
955
+ end
956
+
957
+ # Gets information about a backend's traffic.
958
+ # @param [String] name
959
+ # Required. Name of the resource in the format: `projects/`project`/locations/`
960
+ # locationId`/backends/`backendId`/traffic`.
961
+ # @param [String] fields
962
+ # Selector specifying which fields to include in a partial response.
963
+ # @param [String] quota_user
964
+ # Available to use for quota purposes for server-side applications. Can be any
965
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
966
+ # @param [Google::Apis::RequestOptions] options
967
+ # Request-specific options
968
+ #
969
+ # @yield [result, err] Result & error if block supplied
970
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Traffic] parsed result object
971
+ # @yieldparam err [StandardError] error object if request failed
972
+ #
973
+ # @return [Google::Apis::FirebaseapphostingV1::Traffic]
974
+ #
975
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
976
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
977
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
978
+ def get_project_location_backend_traffic(name, fields: nil, quota_user: nil, options: nil, &block)
979
+ command = make_simple_command(:get, 'v1/{+name}', options)
980
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Traffic::Representation
981
+ command.response_class = Google::Apis::FirebaseapphostingV1::Traffic
982
+ command.params['name'] = name unless name.nil?
983
+ command.query['fields'] = fields unless fields.nil?
984
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
985
+ execute_or_queue_command(command, &block)
986
+ end
987
+
988
+ # Updates a backend's traffic.
989
+ # @param [String] name
990
+ # Identifier. The resource name of the backend's traffic. Format: `projects/`
991
+ # project`/locations/`locationId`/backends/`backendId`/traffic`.
992
+ # @param [Google::Apis::FirebaseapphostingV1::Traffic] traffic_object
993
+ # @param [String] request_id
994
+ # Optional. An optional request ID to identify requests. Specify a unique
995
+ # request ID so that if you must retry your request, the server will know to
996
+ # ignore the request if it has already been completed. The server will guarantee
997
+ # that for at least 60 minutes since the first request. For example, consider a
998
+ # situation where you make an initial request and t he request times out. If you
999
+ # make the request again with the same request ID, the server can check if
1000
+ # original operation with the same request ID was received, and if so, will
1001
+ # ignore the second request. This prevents clients from accidentally creating
1002
+ # duplicate commitments. The request ID must be a valid UUID with the exception
1003
+ # that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1004
+ # @param [String] update_mask
1005
+ # Optional. Field mask is used to specify the fields to be overwritten in the
1006
+ # traffic resource by the update. The fields specified in the update_mask are
1007
+ # relative to the resource, not the full request. A field will be overwritten if
1008
+ # it is in the mask. If the user does not provide a mask then all fields will be
1009
+ # overwritten.
1010
+ # @param [Boolean] validate_only
1011
+ # Optional. Indicates that the request should be validated, without persisting
1012
+ # the request or updating any resources.
1013
+ # @param [String] fields
1014
+ # Selector specifying which fields to include in a partial response.
1015
+ # @param [String] quota_user
1016
+ # Available to use for quota purposes for server-side applications. Can be any
1017
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1018
+ # @param [Google::Apis::RequestOptions] options
1019
+ # Request-specific options
1020
+ #
1021
+ # @yield [result, err] Result & error if block supplied
1022
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
1023
+ # @yieldparam err [StandardError] error object if request failed
1024
+ #
1025
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
1026
+ #
1027
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1028
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1029
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1030
+ def patch_project_location_backend_traffic(name, traffic_object = nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
1031
+ command = make_simple_command(:patch, 'v1/{+name}', options)
1032
+ command.request_representation = Google::Apis::FirebaseapphostingV1::Traffic::Representation
1033
+ command.request_object = traffic_object
1034
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
1035
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
1036
+ command.params['name'] = name unless name.nil?
1037
+ command.query['requestId'] = request_id unless request_id.nil?
1038
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1039
+ command.query['validateOnly'] = validate_only unless validate_only.nil?
1040
+ command.query['fields'] = fields unless fields.nil?
1041
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1042
+ execute_or_queue_command(command, &block)
1043
+ end
1044
+
1045
+ # Starts asynchronous cancellation on a long-running operation. The server makes
1046
+ # a best effort to cancel the operation, but success is not guaranteed. If the
1047
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
1048
+ # Clients can use Operations.GetOperation or other methods to check whether the
1049
+ # cancellation succeeded or whether the operation completed despite cancellation.
1050
+ # On successful cancellation, the operation is not deleted; instead, it becomes
1051
+ # an operation with an Operation.error value with a google.rpc.Status.code of `1`
1052
+ # , corresponding to `Code.CANCELLED`.
1053
+ # @param [String] name
1054
+ # The name of the operation resource to be cancelled.
1055
+ # @param [Google::Apis::FirebaseapphostingV1::CancelOperationRequest] cancel_operation_request_object
1056
+ # @param [String] fields
1057
+ # Selector specifying which fields to include in a partial response.
1058
+ # @param [String] quota_user
1059
+ # Available to use for quota purposes for server-side applications. Can be any
1060
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1061
+ # @param [Google::Apis::RequestOptions] options
1062
+ # Request-specific options
1063
+ #
1064
+ # @yield [result, err] Result & error if block supplied
1065
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Empty] parsed result object
1066
+ # @yieldparam err [StandardError] error object if request failed
1067
+ #
1068
+ # @return [Google::Apis::FirebaseapphostingV1::Empty]
1069
+ #
1070
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1071
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1072
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1073
+ def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1074
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
1075
+ command.request_representation = Google::Apis::FirebaseapphostingV1::CancelOperationRequest::Representation
1076
+ command.request_object = cancel_operation_request_object
1077
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Empty::Representation
1078
+ command.response_class = Google::Apis::FirebaseapphostingV1::Empty
1079
+ command.params['name'] = name unless name.nil?
1080
+ command.query['fields'] = fields unless fields.nil?
1081
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1082
+ execute_or_queue_command(command, &block)
1083
+ end
1084
+
1085
+ # Deletes a long-running operation. This method indicates that the client is no
1086
+ # longer interested in the operation result. It does not cancel the operation.
1087
+ # If the server doesn't support this method, it returns `google.rpc.Code.
1088
+ # UNIMPLEMENTED`.
1089
+ # @param [String] name
1090
+ # The name of the operation resource to be deleted.
1091
+ # @param [String] fields
1092
+ # Selector specifying which fields to include in a partial response.
1093
+ # @param [String] quota_user
1094
+ # Available to use for quota purposes for server-side applications. Can be any
1095
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1096
+ # @param [Google::Apis::RequestOptions] options
1097
+ # Request-specific options
1098
+ #
1099
+ # @yield [result, err] Result & error if block supplied
1100
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Empty] parsed result object
1101
+ # @yieldparam err [StandardError] error object if request failed
1102
+ #
1103
+ # @return [Google::Apis::FirebaseapphostingV1::Empty]
1104
+ #
1105
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1106
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1107
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1108
+ def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1109
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1110
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Empty::Representation
1111
+ command.response_class = Google::Apis::FirebaseapphostingV1::Empty
1112
+ command.params['name'] = name unless name.nil?
1113
+ command.query['fields'] = fields unless fields.nil?
1114
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1115
+ execute_or_queue_command(command, &block)
1116
+ end
1117
+
1118
+ # Gets the latest state of a long-running operation. Clients can use this method
1119
+ # to poll the operation result at intervals as recommended by the API service.
1120
+ # @param [String] name
1121
+ # The name of the operation resource.
1122
+ # @param [String] fields
1123
+ # Selector specifying which fields to include in a partial response.
1124
+ # @param [String] quota_user
1125
+ # Available to use for quota purposes for server-side applications. Can be any
1126
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1127
+ # @param [Google::Apis::RequestOptions] options
1128
+ # Request-specific options
1129
+ #
1130
+ # @yield [result, err] Result & error if block supplied
1131
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::Operation] parsed result object
1132
+ # @yieldparam err [StandardError] error object if request failed
1133
+ #
1134
+ # @return [Google::Apis::FirebaseapphostingV1::Operation]
1135
+ #
1136
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1137
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1138
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1139
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1140
+ command = make_simple_command(:get, 'v1/{+name}', options)
1141
+ command.response_representation = Google::Apis::FirebaseapphostingV1::Operation::Representation
1142
+ command.response_class = Google::Apis::FirebaseapphostingV1::Operation
1143
+ command.params['name'] = name unless name.nil?
1144
+ command.query['fields'] = fields unless fields.nil?
1145
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1146
+ execute_or_queue_command(command, &block)
1147
+ end
1148
+
1149
+ # Lists operations that match the specified filter in the request. If the server
1150
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
1151
+ # @param [String] name
1152
+ # The name of the operation's parent resource.
1153
+ # @param [String] filter
1154
+ # The standard list filter.
1155
+ # @param [Fixnum] page_size
1156
+ # The standard list page size.
1157
+ # @param [String] page_token
1158
+ # The standard list page token.
1159
+ # @param [String] fields
1160
+ # Selector specifying which fields to include in a partial response.
1161
+ # @param [String] quota_user
1162
+ # Available to use for quota purposes for server-side applications. Can be any
1163
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1164
+ # @param [Google::Apis::RequestOptions] options
1165
+ # Request-specific options
1166
+ #
1167
+ # @yield [result, err] Result & error if block supplied
1168
+ # @yieldparam result [Google::Apis::FirebaseapphostingV1::ListOperationsResponse] parsed result object
1169
+ # @yieldparam err [StandardError] error object if request failed
1170
+ #
1171
+ # @return [Google::Apis::FirebaseapphostingV1::ListOperationsResponse]
1172
+ #
1173
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1174
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1175
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1176
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1177
+ command = make_simple_command(:get, 'v1/{+name}/operations', options)
1178
+ command.response_representation = Google::Apis::FirebaseapphostingV1::ListOperationsResponse::Representation
1179
+ command.response_class = Google::Apis::FirebaseapphostingV1::ListOperationsResponse
1180
+ command.params['name'] = name unless name.nil?
1181
+ command.query['filter'] = filter unless filter.nil?
1182
+ command.query['pageSize'] = page_size unless page_size.nil?
1183
+ command.query['pageToken'] = page_token unless page_token.nil?
1184
+ command.query['fields'] = fields unless fields.nil?
1185
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1186
+ execute_or_queue_command(command, &block)
1187
+ end
1188
+
1189
+ protected
1190
+
1191
+ def apply_command_defaults(command)
1192
+ command.query['key'] = key unless key.nil?
1193
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1194
+ end
1195
+ end
1196
+ end
1197
+ end
1198
+ end