google-apis-firebasehosting_v1beta1 0.1.0 → 0.6.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.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirebasehostingV1beta1
18
18
  # Version of the google-apis-firebasehosting_v1beta1 gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.6.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.1"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20201024"
25
+ REVISION = "20210415"
26
26
  end
27
27
  end
28
28
  end
@@ -112,6 +112,12 @@ module Google
112
112
  include Google::Apis::Core::JsonObjectSupport
113
113
  end
114
114
 
115
+ class ListSitesResponse
116
+ class Representation < Google::Apis::Core::JsonRepresentation; end
117
+
118
+ include Google::Apis::Core::JsonObjectSupport
119
+ end
120
+
115
121
  class ListVersionFilesResponse
116
122
  class Representation < Google::Apis::Core::JsonRepresentation; end
117
123
 
@@ -178,6 +184,12 @@ module Google
178
184
  include Google::Apis::Core::JsonObjectSupport
179
185
  end
180
186
 
187
+ class Site
188
+ class Representation < Google::Apis::Core::JsonRepresentation; end
189
+
190
+ include Google::Apis::Core::JsonObjectSupport
191
+ end
192
+
181
193
  class SiteConfig
182
194
  class Representation < Google::Apis::Core::JsonRepresentation; end
183
195
 
@@ -349,6 +361,15 @@ module Google
349
361
  end
350
362
  end
351
363
 
364
+ class ListSitesResponse
365
+ # @private
366
+ class Representation < Google::Apis::Core::JsonRepresentation
367
+ property :next_page_token, as: 'nextPageToken'
368
+ collection :sites, as: 'sites', class: Google::Apis::FirebasehostingV1beta1::Site, decorator: Google::Apis::FirebasehostingV1beta1::Site::Representation
369
+
370
+ end
371
+ end
372
+
352
373
  class ListVersionFilesResponse
353
374
  # @private
354
375
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -463,6 +484,17 @@ module Google
463
484
  end
464
485
  end
465
486
 
487
+ class Site
488
+ # @private
489
+ class Representation < Google::Apis::Core::JsonRepresentation
490
+ property :app_id, as: 'appId'
491
+ property :default_url, as: 'defaultUrl'
492
+ hash :labels, as: 'labels'
493
+ property :name, as: 'name'
494
+ property :type, as: 'type'
495
+ end
496
+ end
497
+
466
498
  class SiteConfig
467
499
  # @private
468
500
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -22,9 +22,10 @@ module Google
22
22
  module FirebasehostingV1beta1
23
23
  # Firebase Hosting API
24
24
  #
25
- # The Firebase Hosting REST API enables programmatic and customizable
26
- # deployments to your Firebase-hosted sites. Use this REST API to deploy new or
27
- # updated hosting configurations and content files.
25
+ # The Firebase Hosting REST API enables programmatic and customizable management
26
+ # and deployments to your Firebase-hosted sites. Use this REST API to create and
27
+ # manage channels and sites as well as to deploy new or updated hosting
28
+ # configurations and content files.
28
29
  #
29
30
  # @example
30
31
  # require 'google/apis/firebasehosting_v1beta1'
@@ -82,6 +83,115 @@ module Google
82
83
  execute_or_queue_command(command, &block)
83
84
  end
84
85
 
86
+ # Creates a new Hosting Site in the specified parent Firebase project. Note that
87
+ # Hosting sites can take several minutes to propagate through Firebase systems.
88
+ # @param [String] parent
89
+ # Required. The Firebase project in which to create a Hosting site, in the
90
+ # format: projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#
91
+ # Site.FIELDS.name) field for details about PROJECT_IDENTIFIER values.
92
+ # @param [Google::Apis::FirebasehostingV1beta1::Site] site_object
93
+ # @param [String] site_id
94
+ # Required. Immutable. A globally unique identifier for the Hosting site. This
95
+ # identifier is used to construct the Firebase-provisioned subdomains for the
96
+ # site, so it must also be a valid domain name label.
97
+ # @param [String] fields
98
+ # Selector specifying which fields to include in a partial response.
99
+ # @param [String] quota_user
100
+ # Available to use for quota purposes for server-side applications. Can be any
101
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
102
+ # @param [Google::Apis::RequestOptions] options
103
+ # Request-specific options
104
+ #
105
+ # @yield [result, err] Result & error if block supplied
106
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Site] parsed result object
107
+ # @yieldparam err [StandardError] error object if request failed
108
+ #
109
+ # @return [Google::Apis::FirebasehostingV1beta1::Site]
110
+ #
111
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
112
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
113
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
114
+ def create_project_site(parent, site_object = nil, site_id: nil, fields: nil, quota_user: nil, options: nil, &block)
115
+ command = make_simple_command(:post, 'v1beta1/{+parent}/sites', options)
116
+ command.request_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
117
+ command.request_object = site_object
118
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
119
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Site
120
+ command.params['parent'] = parent unless parent.nil?
121
+ command.query['siteId'] = site_id unless site_id.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
+ # Deletes the specified Hosting Site from the specified parent Firebase project.
128
+ # @param [String] name
129
+ # Required. The fully-qualified resource name for the Hosting site, in the
130
+ # format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](
131
+ # ../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER
132
+ # values.
133
+ # @param [String] fields
134
+ # Selector specifying which fields to include in a partial response.
135
+ # @param [String] quota_user
136
+ # Available to use for quota purposes for server-side applications. Can be any
137
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
138
+ # @param [Google::Apis::RequestOptions] options
139
+ # Request-specific options
140
+ #
141
+ # @yield [result, err] Result & error if block supplied
142
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Empty] parsed result object
143
+ # @yieldparam err [StandardError] error object if request failed
144
+ #
145
+ # @return [Google::Apis::FirebasehostingV1beta1::Empty]
146
+ #
147
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
148
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
149
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
150
+ def delete_project_site(name, fields: nil, quota_user: nil, options: nil, &block)
151
+ command = make_simple_command(:delete, 'v1beta1/{+name}', options)
152
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Empty::Representation
153
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Empty
154
+ command.params['name'] = name unless name.nil?
155
+ command.query['fields'] = fields unless fields.nil?
156
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
157
+ execute_or_queue_command(command, &block)
158
+ end
159
+
160
+ # Gets the specified Hosting Site.
161
+ # @param [String] name
162
+ # Required. The fully-qualified resource name for the Hosting site, in the
163
+ # format: projects/PROJECT_IDENTIFIER/sites/SITE_ID Refer to the `Site` [`name`](
164
+ # ../projects#Site.FIELDS.name) field for details about PROJECT_IDENTIFIER
165
+ # values. Since a SITE_ID is a globally unique identifier, you can also use the
166
+ # unique sub-collection resource access pattern, in the format: projects/-/sites/
167
+ # SITE_ID
168
+ # @param [String] fields
169
+ # Selector specifying which fields to include in a partial response.
170
+ # @param [String] quota_user
171
+ # Available to use for quota purposes for server-side applications. Can be any
172
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
173
+ # @param [Google::Apis::RequestOptions] options
174
+ # Request-specific options
175
+ #
176
+ # @yield [result, err] Result & error if block supplied
177
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Site] parsed result object
178
+ # @yieldparam err [StandardError] error object if request failed
179
+ #
180
+ # @return [Google::Apis::FirebasehostingV1beta1::Site]
181
+ #
182
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
183
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
184
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
185
+ def get_project_site(name, fields: nil, quota_user: nil, options: nil, &block)
186
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
187
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
188
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Site
189
+ command.params['name'] = name unless name.nil?
190
+ command.query['fields'] = fields unless fields.nil?
191
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
192
+ execute_or_queue_command(command, &block)
193
+ end
194
+
85
195
  # Gets the Hosting metadata for a specific site.
86
196
  # @param [String] name
87
197
  # Required. The site for which to get the SiteConfig, in the format: sites/ site-
@@ -113,6 +223,90 @@ module Google
113
223
  execute_or_queue_command(command, &block)
114
224
  end
115
225
 
226
+ # Lists each Hosting Site associated with the specified parent Firebase project.
227
+ # @param [String] parent
228
+ # Required. The Firebase project for which to list sites, in the format:
229
+ # projects/PROJECT_IDENTIFIER Refer to the `Site` [`name`](../projects#Site.
230
+ # FIELDS.name) field for details about PROJECT_IDENTIFIER values.
231
+ # @param [Fixnum] page_size
232
+ # Optional. The maximum number of sites to return. The service may return a
233
+ # lower number if fewer sites exist than this maximum number. If unspecified,
234
+ # defaults to 40.
235
+ # @param [String] page_token
236
+ # Optional. A token from a previous call to `ListSites` that tells the server
237
+ # where to resume listing.
238
+ # @param [String] fields
239
+ # Selector specifying which fields to include in a partial response.
240
+ # @param [String] quota_user
241
+ # Available to use for quota purposes for server-side applications. Can be any
242
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
243
+ # @param [Google::Apis::RequestOptions] options
244
+ # Request-specific options
245
+ #
246
+ # @yield [result, err] Result & error if block supplied
247
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::ListSitesResponse] parsed result object
248
+ # @yieldparam err [StandardError] error object if request failed
249
+ #
250
+ # @return [Google::Apis::FirebasehostingV1beta1::ListSitesResponse]
251
+ #
252
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
253
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
254
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
255
+ def list_project_sites(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
256
+ command = make_simple_command(:get, 'v1beta1/{+parent}/sites', options)
257
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::ListSitesResponse::Representation
258
+ command.response_class = Google::Apis::FirebasehostingV1beta1::ListSitesResponse
259
+ command.params['parent'] = parent unless parent.nil?
260
+ command.query['pageSize'] = page_size unless page_size.nil?
261
+ command.query['pageToken'] = page_token unless page_token.nil?
262
+ command.query['fields'] = fields unless fields.nil?
263
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
264
+ execute_or_queue_command(command, &block)
265
+ end
266
+
267
+ # Updates attributes of the specified Hosting Site.
268
+ # @param [String] name
269
+ # Output only. The fully-qualified resource name of the Hosting site, in the
270
+ # format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the
271
+ # Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/
272
+ # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(
273
+ # recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/
274
+ # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn
275
+ # more about using project identifiers in Google's [AIP 2510 standard](https://
276
+ # google.aip.dev/cloud/2510).
277
+ # @param [Google::Apis::FirebasehostingV1beta1::Site] site_object
278
+ # @param [String] update_mask
279
+ # A set of field names from your Site that you want to update.
280
+ # @param [String] fields
281
+ # Selector specifying which fields to include in a partial response.
282
+ # @param [String] quota_user
283
+ # Available to use for quota purposes for server-side applications. Can be any
284
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
285
+ # @param [Google::Apis::RequestOptions] options
286
+ # Request-specific options
287
+ #
288
+ # @yield [result, err] Result & error if block supplied
289
+ # @yieldparam result [Google::Apis::FirebasehostingV1beta1::Site] parsed result object
290
+ # @yieldparam err [StandardError] error object if request failed
291
+ #
292
+ # @return [Google::Apis::FirebasehostingV1beta1::Site]
293
+ #
294
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
295
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
296
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
297
+ def patch_project_site(name, site_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
298
+ command = make_simple_command(:patch, 'v1beta1/{+name}', options)
299
+ command.request_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
300
+ command.request_object = site_object
301
+ command.response_representation = Google::Apis::FirebasehostingV1beta1::Site::Representation
302
+ command.response_class = Google::Apis::FirebasehostingV1beta1::Site
303
+ command.params['name'] = name unless name.nil?
304
+ command.query['updateMask'] = update_mask unless update_mask.nil?
305
+ command.query['fields'] = fields unless fields.nil?
306
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
307
+ execute_or_queue_command(command, &block)
308
+ end
309
+
116
310
  # Sets the Hosting metadata for a specific site.
117
311
  # @param [String] name
118
312
  # Required. The site for which to update the SiteConfig, in the format: sites/
@@ -155,10 +349,11 @@ module Google
155
349
 
156
350
  # Creates a new channel in the specified site.
157
351
  # @param [String] parent
158
- # Required. The site in which this channel should be created.
352
+ # Required. The site in which to create this channel, in the format: sites/
353
+ # SITE_ID
159
354
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
160
355
  # @param [String] channel_id
161
- # Required. Immutable. A unique id within the site to identify the channel.
356
+ # Required. Immutable. A unique ID within the site that identifies the channel.
162
357
  # @param [String] fields
163
358
  # Selector specifying which fields to include in a partial response.
164
359
  # @param [String] quota_user
@@ -189,9 +384,11 @@ module Google
189
384
  execute_or_queue_command(command, &block)
190
385
  end
191
386
 
192
- # Deletes a channel of a site. The `live` channel cannot be deleted.
387
+ # Deletes the specified channel of the specified site. The `live` channel cannot
388
+ # be deleted.
193
389
  # @param [String] name
194
- # Required. The fully-qualified identifier for the site.
390
+ # Required. The fully-qualified resource name for the channel, in the format:
391
+ # sites/SITE_ID/channels/CHANNEL_ID
195
392
  # @param [String] fields
196
393
  # Selector specifying which fields to include in a partial response.
197
394
  # @param [String] quota_user
@@ -219,9 +416,10 @@ module Google
219
416
  execute_or_queue_command(command, &block)
220
417
  end
221
418
 
222
- # Retrieves information for the specified channel of a site.
419
+ # Retrieves information for the specified channel of the specified site.
223
420
  # @param [String] name
224
- # Required. The fully-qualified identifier for the channel.
421
+ # Required. The fully-qualified resource name for the channel, in the format:
422
+ # sites/SITE_ID/channels/CHANNEL_ID
225
423
  # @param [String] fields
226
424
  # Selector specifying which fields to include in a partial response.
227
425
  # @param [String] quota_user
@@ -249,16 +447,18 @@ module Google
249
447
  execute_or_queue_command(command, &block)
250
448
  end
251
449
 
252
- # Lists the channels for the specified site. All sites have a default "live"
450
+ # Lists the channels for the specified site. All sites have a default `live`
253
451
  # channel.
254
452
  # @param [String] parent
255
- # Required. The site from which to list channels.
453
+ # Required. The site for which to list channels, in the format: sites/SITE_ID
256
454
  # @param [Fixnum] page_size
257
- # The maximum number of versions to return. The service may return fewer than
258
- # this value. If unspecified, at most 25 channels will be returned. The maximum
259
- # value is 100; valuupdateses above 100 will be coerced to 100
455
+ # The maximum number of channels to return. The service may return a lower
456
+ # number if fewer channels exist than this maximum number. If unspecified,
457
+ # defaults to 10. The maximum value is 100; values above 100 will be coerced to
458
+ # 100.
260
459
  # @param [String] page_token
261
- # The next_page_token from a previous request, if provided.
460
+ # A token from a previous call to `ListChannels` that tells the server where to
461
+ # resume listing.
262
462
  # @param [String] fields
263
463
  # Selector specifying which fields to include in a partial response.
264
464
  # @param [String] quota_user
@@ -288,10 +488,11 @@ module Google
288
488
  execute_or_queue_command(command, &block)
289
489
  end
290
490
 
291
- # Updates information for the specified channel of a site. This method will
292
- # implicitly create a channel if it doesn't exist.
491
+ # Updates information for the specified channel of the specified site.
492
+ # Implicitly creates the channel if it doesn't already exist.
293
493
  # @param [String] name
294
- # The fully-qualified identifier of the Channel.
494
+ # The fully-qualified resource name for the channel, in the format: sites/
495
+ # SITE_ID/channels/CHANNEL_ID
295
496
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
296
497
  # @param [String] update_mask
297
498
  # A comma-separated list of fields to be updated in this request.
@@ -325,15 +526,15 @@ module Google
325
526
  execute_or_queue_command(command, &block)
326
527
  end
327
528
 
328
- # Creates a new release which makes the content of the specified version
529
+ # Creates a new release, which makes the content of the specified version
329
530
  # actively display on the appropriate URL(s).
330
531
  # @param [String] parent
331
- # Required. The site that the release belongs to, in the format: sites/ site-
332
- # name
532
+ # Required. The site or channel to which the release belongs, in either of the
533
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
333
534
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
334
535
  # @param [String] version_name
335
- # The unique identifier for a version, in the format: /sites/site-name /versions/
336
- # versionID The site-name in this version identifier must match the site-name in
536
+ # The unique identifier for a version, in the format: sites/SITE_ID/versions/
537
+ # VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in
337
538
  # the `parent` parameter. This query parameter must be empty if the `type` field
338
539
  # in the request body is `SITE_DISABLE`.
339
540
  # @param [String] fields
@@ -366,13 +567,20 @@ module Google
366
567
  execute_or_queue_command(command, &block)
367
568
  end
368
569
 
369
- # Lists the releases that have been created on the specified site.
570
+ # Lists the releases that have been created for the specified site or channel.
571
+ # When used to list releases for a site, this list includes releases for both
572
+ # the default `live` channel and any active preview channels for the specified
573
+ # site.
370
574
  # @param [String] parent
371
- # Required. The parent for which to list files, in the format: sites/site-name
575
+ # Required. The site or channel for which to list releases, in either of the
576
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
372
577
  # @param [Fixnum] page_size
373
- # The page size to return. Defaults to 100.
578
+ # The maximum number of releases to return. The service may return a lower
579
+ # number if fewer releases exist than this maximum number. If unspecified,
580
+ # defaults to 100.
374
581
  # @param [String] page_token
375
- # The next_page_token from a previous request, if provided.
582
+ # A token from a previous call to `releases.list` or `channels.releases.list`
583
+ # that tells the server where to resume listing.
376
584
  # @param [String] fields
377
585
  # Selector specifying which fields to include in a partial response.
378
586
  # @param [String] quota_user
@@ -568,15 +776,15 @@ module Google
568
776
  execute_or_queue_command(command, &block)
569
777
  end
570
778
 
571
- # Creates a new release which makes the content of the specified version
779
+ # Creates a new release, which makes the content of the specified version
572
780
  # actively display on the appropriate URL(s).
573
781
  # @param [String] parent
574
- # Required. The site that the release belongs to, in the format: sites/ site-
575
- # name
782
+ # Required. The site or channel to which the release belongs, in either of the
783
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
576
784
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
577
785
  # @param [String] version_name
578
- # The unique identifier for a version, in the format: /sites/site-name /versions/
579
- # versionID The site-name in this version identifier must match the site-name in
786
+ # The unique identifier for a version, in the format: sites/SITE_ID/versions/
787
+ # VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in
580
788
  # the `parent` parameter. This query parameter must be empty if the `type` field
581
789
  # in the request body is `SITE_DISABLE`.
582
790
  # @param [String] fields
@@ -609,13 +817,20 @@ module Google
609
817
  execute_or_queue_command(command, &block)
610
818
  end
611
819
 
612
- # Lists the releases that have been created on the specified site.
820
+ # Lists the releases that have been created for the specified site or channel.
821
+ # When used to list releases for a site, this list includes releases for both
822
+ # the default `live` channel and any active preview channels for the specified
823
+ # site.
613
824
  # @param [String] parent
614
- # Required. The parent for which to list files, in the format: sites/site-name
825
+ # Required. The site or channel for which to list releases, in either of the
826
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
615
827
  # @param [Fixnum] page_size
616
- # The page size to return. Defaults to 100.
828
+ # The maximum number of releases to return. The service may return a lower
829
+ # number if fewer releases exist than this maximum number. If unspecified,
830
+ # defaults to 100.
617
831
  # @param [String] page_token
618
- # The next_page_token from a previous request, if provided.
832
+ # A token from a previous call to `releases.list` or `channels.releases.list`
833
+ # that tells the server where to resume listing.
619
834
  # @param [String] fields
620
835
  # Selector specifying which fields to include in a partial response.
621
836
  # @param [String] quota_user
@@ -645,11 +860,11 @@ module Google
645
860
  execute_or_queue_command(command, &block)
646
861
  end
647
862
 
648
- # Creates a new version on the target site using the content of the specified
649
- # version.
863
+ # Creates a new version on the specified target site using the content of the
864
+ # specified version.
650
865
  # @param [String] parent
651
- # Required. The target site where the cloned version will reside, in the format:
652
- # `sites/`site``
866
+ # Required. The target site for the cloned version, in the format: sites/
867
+ # SITE_ID
653
868
  # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object
654
869
  # @param [String] fields
655
870
  # Selector specifying which fields to include in a partial response.
@@ -680,10 +895,10 @@ module Google
680
895
  execute_or_queue_command(command, &block)
681
896
  end
682
897
 
683
- # Creates a new version for a site.
898
+ # Creates a new version for the specified site.
684
899
  # @param [String] parent
685
- # Required. The parent to create the version for, in the format: sites/ site-
686
- # name
900
+ # Required. The site in which to create the version, in the format: sites/
901
+ # SITE_ID
687
902
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
688
903
  # @param [Fixnum] size_bytes
689
904
  # The self-reported size of the version. This value is used for a pre-emptive
@@ -724,8 +939,8 @@ module Google
724
939
 
725
940
  # Deletes the specified version.
726
941
  # @param [String] name
727
- # Required. The name of the version to be deleted, in the format: sites/ site-
728
- # name/versions/versionID
942
+ # Required. The fully-qualified resource name for the version, in the format:
943
+ # sites/SITE_ID/versions/VERSION_ID
729
944
  # @param [String] fields
730
945
  # Selector specifying which fields to include in a partial response.
731
946
  # @param [String] quota_user
@@ -753,20 +968,25 @@ module Google
753
968
  execute_or_queue_command(command, &block)
754
969
  end
755
970
 
756
- # Lists the versions that have been created on the specified site. Will include
757
- # filtering in the future.
971
+ # Lists the versions that have been created for the specified site. This list
972
+ # includes versions for both the default `live` channel and any active preview
973
+ # channels for the specified site.
758
974
  # @param [String] parent
759
- # Required. The parent for which to list files, in the format: sites/site-name
975
+ # Required. The site or channel for which to list versions, in either of the
976
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
760
977
  # @param [String] filter
761
- # The filter string used to return a subset of versions in the response.
762
- # Currently supported fields for filtering are: name, status, and create_time.
763
- # Filter processing will be implemented in accordance with go/filtering.
978
+ # A filter string used to return a subset of versions in the response. The
979
+ # currently supported fields for filtering are: `name`, `status`, and `
980
+ # create_time`. Learn more about filtering in Google's [AIP 160 standard](https:/
981
+ # /google.aip.dev/160).
764
982
  # @param [Fixnum] page_size
765
- # The maximum number of versions to return. The service may return fewer than
766
- # this value. If unspecified, at most 25 versions will be returned. The maximum
767
- # value is 100; values above 100 will be coerced to 100
983
+ # The maximum number of versions to return. The service may return a lower
984
+ # number if fewer versions exist than this maximum number. If unspecified,
985
+ # defaults to 25. The maximum value is 100; values above 100 will be coerced to
986
+ # 100.
768
987
  # @param [String] page_token
769
- # The next_page_token from a previous request, if provided.
988
+ # A token from a previous call to `ListVersions` that tells the server where to
989
+ # resume listing.
770
990
  # @param [String] fields
771
991
  # Selector specifying which fields to include in a partial response.
772
992
  # @param [String] quota_user
@@ -797,15 +1017,15 @@ module Google
797
1017
  execute_or_queue_command(command, &block)
798
1018
  end
799
1019
 
800
- # Updates the specified metadata for a version. Note that this method will fail
801
- # with `FAILED_PRECONDITION` in the event of an invalid state transition. The
802
- # only valid transition for a version is currently from a `CREATED` status to a `
803
- # FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the
804
- # status of a version to `DELETED`.
1020
+ # Updates the specified metadata for the specified version. This method will
1021
+ # fail with `FAILED_PRECONDITION` in the event of an invalid state transition.
1022
+ # The supported [state](../sites.versions#versionstatus) transitions for a
1023
+ # version are from `CREATED` to `FINALIZED`. Use [`DeleteVersion`](delete) to
1024
+ # set the status of a version to `DELETED`.
805
1025
  # @param [String] name
806
- # The unique identifier for a version, in the format: sites/site-name /versions/
807
- # versionID This name is provided in the response body when you call the [`
808
- # CreateVersion`](../sites.versions/create) endpoint.
1026
+ # The fully-qualified resource name for the version, in the format: sites/
1027
+ # SITE_ID/versions/VERSION_ID This name is provided in the response body when
1028
+ # you call [`CreateVersion`](sites.versions/create).
809
1029
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
810
1030
  # @param [String] update_mask
811
1031
  # A set of field names from your [version](../sites.versions) that you want to
@@ -842,10 +1062,10 @@ module Google
842
1062
  execute_or_queue_command(command, &block)
843
1063
  end
844
1064
 
845
- # Adds content files to a version. Each file must be under 2 GB.
1065
+ # Adds content files to the specified version. Each file must be under 2 GB.
846
1066
  # @param [String] parent
847
- # Required. The version to add files to, in the format: sites/site-name /
848
- # versions/versionID
1067
+ # Required. The version to which to add files, in the format: sites/SITE_ID /
1068
+ # versions/VERSION_ID
849
1069
  # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
850
1070
  # @param [String] fields
851
1071
  # Selector specifying which fields to include in a partial response.
@@ -878,15 +1098,17 @@ module Google
878
1098
 
879
1099
  # Lists the remaining files to be uploaded for the specified version.
880
1100
  # @param [String] parent
881
- # Required. The parent to list files for, in the format: sites/site-name /
882
- # versions/versionID
1101
+ # Required. The version for which to list files, in the format: sites/SITE_ID /
1102
+ # versions/VERSION_ID
883
1103
  # @param [Fixnum] page_size
884
- # The page size to return. Defaults to 1000.
1104
+ # The maximum number of version files to return. The service may return a lower
1105
+ # number if fewer version files exist than this maximum number. If unspecified,
1106
+ # defaults to 1000.
885
1107
  # @param [String] page_token
886
- # The next_page_token from a previous request, if provided. This will be the
887
- # encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
1108
+ # A token from a previous call to `ListVersionFiles` that tells the server where
1109
+ # to resume listing.
888
1110
  # @param [String] status
889
- # The type of files in the version that should be listed.
1111
+ # The type of files that should be listed for the specified version.
890
1112
  # @param [String] fields
891
1113
  # Selector specifying which fields to include in a partial response.
892
1114
  # @param [String] quota_user
@@ -990,10 +1212,11 @@ module Google
990
1212
 
991
1213
  # Creates a new channel in the specified site.
992
1214
  # @param [String] parent
993
- # Required. The site in which this channel should be created.
1215
+ # Required. The site in which to create this channel, in the format: sites/
1216
+ # SITE_ID
994
1217
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
995
1218
  # @param [String] channel_id
996
- # Required. Immutable. A unique id within the site to identify the channel.
1219
+ # Required. Immutable. A unique ID within the site that identifies the channel.
997
1220
  # @param [String] fields
998
1221
  # Selector specifying which fields to include in a partial response.
999
1222
  # @param [String] quota_user
@@ -1024,9 +1247,11 @@ module Google
1024
1247
  execute_or_queue_command(command, &block)
1025
1248
  end
1026
1249
 
1027
- # Deletes a channel of a site. The `live` channel cannot be deleted.
1250
+ # Deletes the specified channel of the specified site. The `live` channel cannot
1251
+ # be deleted.
1028
1252
  # @param [String] name
1029
- # Required. The fully-qualified identifier for the site.
1253
+ # Required. The fully-qualified resource name for the channel, in the format:
1254
+ # sites/SITE_ID/channels/CHANNEL_ID
1030
1255
  # @param [String] fields
1031
1256
  # Selector specifying which fields to include in a partial response.
1032
1257
  # @param [String] quota_user
@@ -1054,9 +1279,10 @@ module Google
1054
1279
  execute_or_queue_command(command, &block)
1055
1280
  end
1056
1281
 
1057
- # Retrieves information for the specified channel of a site.
1282
+ # Retrieves information for the specified channel of the specified site.
1058
1283
  # @param [String] name
1059
- # Required. The fully-qualified identifier for the channel.
1284
+ # Required. The fully-qualified resource name for the channel, in the format:
1285
+ # sites/SITE_ID/channels/CHANNEL_ID
1060
1286
  # @param [String] fields
1061
1287
  # Selector specifying which fields to include in a partial response.
1062
1288
  # @param [String] quota_user
@@ -1084,16 +1310,18 @@ module Google
1084
1310
  execute_or_queue_command(command, &block)
1085
1311
  end
1086
1312
 
1087
- # Lists the channels for the specified site. All sites have a default "live"
1313
+ # Lists the channels for the specified site. All sites have a default `live`
1088
1314
  # channel.
1089
1315
  # @param [String] parent
1090
- # Required. The site from which to list channels.
1316
+ # Required. The site for which to list channels, in the format: sites/SITE_ID
1091
1317
  # @param [Fixnum] page_size
1092
- # The maximum number of versions to return. The service may return fewer than
1093
- # this value. If unspecified, at most 25 channels will be returned. The maximum
1094
- # value is 100; valuupdateses above 100 will be coerced to 100
1318
+ # The maximum number of channels to return. The service may return a lower
1319
+ # number if fewer channels exist than this maximum number. If unspecified,
1320
+ # defaults to 10. The maximum value is 100; values above 100 will be coerced to
1321
+ # 100.
1095
1322
  # @param [String] page_token
1096
- # The next_page_token from a previous request, if provided.
1323
+ # A token from a previous call to `ListChannels` that tells the server where to
1324
+ # resume listing.
1097
1325
  # @param [String] fields
1098
1326
  # Selector specifying which fields to include in a partial response.
1099
1327
  # @param [String] quota_user
@@ -1123,10 +1351,11 @@ module Google
1123
1351
  execute_or_queue_command(command, &block)
1124
1352
  end
1125
1353
 
1126
- # Updates information for the specified channel of a site. This method will
1127
- # implicitly create a channel if it doesn't exist.
1354
+ # Updates information for the specified channel of the specified site.
1355
+ # Implicitly creates the channel if it doesn't already exist.
1128
1356
  # @param [String] name
1129
- # The fully-qualified identifier of the Channel.
1357
+ # The fully-qualified resource name for the channel, in the format: sites/
1358
+ # SITE_ID/channels/CHANNEL_ID
1130
1359
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
1131
1360
  # @param [String] update_mask
1132
1361
  # A comma-separated list of fields to be updated in this request.
@@ -1160,15 +1389,15 @@ module Google
1160
1389
  execute_or_queue_command(command, &block)
1161
1390
  end
1162
1391
 
1163
- # Creates a new release which makes the content of the specified version
1392
+ # Creates a new release, which makes the content of the specified version
1164
1393
  # actively display on the appropriate URL(s).
1165
1394
  # @param [String] parent
1166
- # Required. The site that the release belongs to, in the format: sites/ site-
1167
- # name
1395
+ # Required. The site or channel to which the release belongs, in either of the
1396
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
1168
1397
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
1169
1398
  # @param [String] version_name
1170
- # The unique identifier for a version, in the format: /sites/site-name /versions/
1171
- # versionID The site-name in this version identifier must match the site-name in
1399
+ # The unique identifier for a version, in the format: sites/SITE_ID/versions/
1400
+ # VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in
1172
1401
  # the `parent` parameter. This query parameter must be empty if the `type` field
1173
1402
  # in the request body is `SITE_DISABLE`.
1174
1403
  # @param [String] fields
@@ -1201,13 +1430,20 @@ module Google
1201
1430
  execute_or_queue_command(command, &block)
1202
1431
  end
1203
1432
 
1204
- # Lists the releases that have been created on the specified site.
1433
+ # Lists the releases that have been created for the specified site or channel.
1434
+ # When used to list releases for a site, this list includes releases for both
1435
+ # the default `live` channel and any active preview channels for the specified
1436
+ # site.
1205
1437
  # @param [String] parent
1206
- # Required. The parent for which to list files, in the format: sites/site-name
1438
+ # Required. The site or channel for which to list releases, in either of the
1439
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
1207
1440
  # @param [Fixnum] page_size
1208
- # The page size to return. Defaults to 100.
1441
+ # The maximum number of releases to return. The service may return a lower
1442
+ # number if fewer releases exist than this maximum number. If unspecified,
1443
+ # defaults to 100.
1209
1444
  # @param [String] page_token
1210
- # The next_page_token from a previous request, if provided.
1445
+ # A token from a previous call to `releases.list` or `channels.releases.list`
1446
+ # that tells the server where to resume listing.
1211
1447
  # @param [String] fields
1212
1448
  # Selector specifying which fields to include in a partial response.
1213
1449
  # @param [String] quota_user
@@ -1403,15 +1639,15 @@ module Google
1403
1639
  execute_or_queue_command(command, &block)
1404
1640
  end
1405
1641
 
1406
- # Creates a new release which makes the content of the specified version
1642
+ # Creates a new release, which makes the content of the specified version
1407
1643
  # actively display on the appropriate URL(s).
1408
1644
  # @param [String] parent
1409
- # Required. The site that the release belongs to, in the format: sites/ site-
1410
- # name
1645
+ # Required. The site or channel to which the release belongs, in either of the
1646
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
1411
1647
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
1412
1648
  # @param [String] version_name
1413
- # The unique identifier for a version, in the format: /sites/site-name /versions/
1414
- # versionID The site-name in this version identifier must match the site-name in
1649
+ # The unique identifier for a version, in the format: sites/SITE_ID/versions/
1650
+ # VERSION_ID The SITE_ID in this version identifier must match the SITE_ID in
1415
1651
  # the `parent` parameter. This query parameter must be empty if the `type` field
1416
1652
  # in the request body is `SITE_DISABLE`.
1417
1653
  # @param [String] fields
@@ -1444,13 +1680,20 @@ module Google
1444
1680
  execute_or_queue_command(command, &block)
1445
1681
  end
1446
1682
 
1447
- # Lists the releases that have been created on the specified site.
1683
+ # Lists the releases that have been created for the specified site or channel.
1684
+ # When used to list releases for a site, this list includes releases for both
1685
+ # the default `live` channel and any active preview channels for the specified
1686
+ # site.
1448
1687
  # @param [String] parent
1449
- # Required. The parent for which to list files, in the format: sites/site-name
1688
+ # Required. The site or channel for which to list releases, in either of the
1689
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
1450
1690
  # @param [Fixnum] page_size
1451
- # The page size to return. Defaults to 100.
1691
+ # The maximum number of releases to return. The service may return a lower
1692
+ # number if fewer releases exist than this maximum number. If unspecified,
1693
+ # defaults to 100.
1452
1694
  # @param [String] page_token
1453
- # The next_page_token from a previous request, if provided.
1695
+ # A token from a previous call to `releases.list` or `channels.releases.list`
1696
+ # that tells the server where to resume listing.
1454
1697
  # @param [String] fields
1455
1698
  # Selector specifying which fields to include in a partial response.
1456
1699
  # @param [String] quota_user
@@ -1480,11 +1723,11 @@ module Google
1480
1723
  execute_or_queue_command(command, &block)
1481
1724
  end
1482
1725
 
1483
- # Creates a new version on the target site using the content of the specified
1484
- # version.
1726
+ # Creates a new version on the specified target site using the content of the
1727
+ # specified version.
1485
1728
  # @param [String] parent
1486
- # Required. The target site where the cloned version will reside, in the format:
1487
- # `sites/`site``
1729
+ # Required. The target site for the cloned version, in the format: sites/
1730
+ # SITE_ID
1488
1731
  # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object
1489
1732
  # @param [String] fields
1490
1733
  # Selector specifying which fields to include in a partial response.
@@ -1515,10 +1758,10 @@ module Google
1515
1758
  execute_or_queue_command(command, &block)
1516
1759
  end
1517
1760
 
1518
- # Creates a new version for a site.
1761
+ # Creates a new version for the specified site.
1519
1762
  # @param [String] parent
1520
- # Required. The parent to create the version for, in the format: sites/ site-
1521
- # name
1763
+ # Required. The site in which to create the version, in the format: sites/
1764
+ # SITE_ID
1522
1765
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
1523
1766
  # @param [Fixnum] size_bytes
1524
1767
  # The self-reported size of the version. This value is used for a pre-emptive
@@ -1559,8 +1802,8 @@ module Google
1559
1802
 
1560
1803
  # Deletes the specified version.
1561
1804
  # @param [String] name
1562
- # Required. The name of the version to be deleted, in the format: sites/ site-
1563
- # name/versions/versionID
1805
+ # Required. The fully-qualified resource name for the version, in the format:
1806
+ # sites/SITE_ID/versions/VERSION_ID
1564
1807
  # @param [String] fields
1565
1808
  # Selector specifying which fields to include in a partial response.
1566
1809
  # @param [String] quota_user
@@ -1588,20 +1831,25 @@ module Google
1588
1831
  execute_or_queue_command(command, &block)
1589
1832
  end
1590
1833
 
1591
- # Lists the versions that have been created on the specified site. Will include
1592
- # filtering in the future.
1834
+ # Lists the versions that have been created for the specified site. This list
1835
+ # includes versions for both the default `live` channel and any active preview
1836
+ # channels for the specified site.
1593
1837
  # @param [String] parent
1594
- # Required. The parent for which to list files, in the format: sites/site-name
1838
+ # Required. The site or channel for which to list versions, in either of the
1839
+ # following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID
1595
1840
  # @param [String] filter
1596
- # The filter string used to return a subset of versions in the response.
1597
- # Currently supported fields for filtering are: name, status, and create_time.
1598
- # Filter processing will be implemented in accordance with go/filtering.
1841
+ # A filter string used to return a subset of versions in the response. The
1842
+ # currently supported fields for filtering are: `name`, `status`, and `
1843
+ # create_time`. Learn more about filtering in Google's [AIP 160 standard](https:/
1844
+ # /google.aip.dev/160).
1599
1845
  # @param [Fixnum] page_size
1600
- # The maximum number of versions to return. The service may return fewer than
1601
- # this value. If unspecified, at most 25 versions will be returned. The maximum
1602
- # value is 100; values above 100 will be coerced to 100
1846
+ # The maximum number of versions to return. The service may return a lower
1847
+ # number if fewer versions exist than this maximum number. If unspecified,
1848
+ # defaults to 25. The maximum value is 100; values above 100 will be coerced to
1849
+ # 100.
1603
1850
  # @param [String] page_token
1604
- # The next_page_token from a previous request, if provided.
1851
+ # A token from a previous call to `ListVersions` that tells the server where to
1852
+ # resume listing.
1605
1853
  # @param [String] fields
1606
1854
  # Selector specifying which fields to include in a partial response.
1607
1855
  # @param [String] quota_user
@@ -1632,15 +1880,15 @@ module Google
1632
1880
  execute_or_queue_command(command, &block)
1633
1881
  end
1634
1882
 
1635
- # Updates the specified metadata for a version. Note that this method will fail
1636
- # with `FAILED_PRECONDITION` in the event of an invalid state transition. The
1637
- # only valid transition for a version is currently from a `CREATED` status to a `
1638
- # FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the
1639
- # status of a version to `DELETED`.
1883
+ # Updates the specified metadata for the specified version. This method will
1884
+ # fail with `FAILED_PRECONDITION` in the event of an invalid state transition.
1885
+ # The supported [state](../sites.versions#versionstatus) transitions for a
1886
+ # version are from `CREATED` to `FINALIZED`. Use [`DeleteVersion`](delete) to
1887
+ # set the status of a version to `DELETED`.
1640
1888
  # @param [String] name
1641
- # The unique identifier for a version, in the format: sites/site-name /versions/
1642
- # versionID This name is provided in the response body when you call the [`
1643
- # CreateVersion`](../sites.versions/create) endpoint.
1889
+ # The fully-qualified resource name for the version, in the format: sites/
1890
+ # SITE_ID/versions/VERSION_ID This name is provided in the response body when
1891
+ # you call [`CreateVersion`](sites.versions/create).
1644
1892
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
1645
1893
  # @param [String] update_mask
1646
1894
  # A set of field names from your [version](../sites.versions) that you want to
@@ -1677,10 +1925,10 @@ module Google
1677
1925
  execute_or_queue_command(command, &block)
1678
1926
  end
1679
1927
 
1680
- # Adds content files to a version. Each file must be under 2 GB.
1928
+ # Adds content files to the specified version. Each file must be under 2 GB.
1681
1929
  # @param [String] parent
1682
- # Required. The version to add files to, in the format: sites/site-name /
1683
- # versions/versionID
1930
+ # Required. The version to which to add files, in the format: sites/SITE_ID /
1931
+ # versions/VERSION_ID
1684
1932
  # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
1685
1933
  # @param [String] fields
1686
1934
  # Selector specifying which fields to include in a partial response.
@@ -1713,15 +1961,17 @@ module Google
1713
1961
 
1714
1962
  # Lists the remaining files to be uploaded for the specified version.
1715
1963
  # @param [String] parent
1716
- # Required. The parent to list files for, in the format: sites/site-name /
1717
- # versions/versionID
1964
+ # Required. The version for which to list files, in the format: sites/SITE_ID /
1965
+ # versions/VERSION_ID
1718
1966
  # @param [Fixnum] page_size
1719
- # The page size to return. Defaults to 1000.
1967
+ # The maximum number of version files to return. The service may return a lower
1968
+ # number if fewer version files exist than this maximum number. If unspecified,
1969
+ # defaults to 1000.
1720
1970
  # @param [String] page_token
1721
- # The next_page_token from a previous request, if provided. This will be the
1722
- # encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken.
1971
+ # A token from a previous call to `ListVersionFiles` that tells the server where
1972
+ # to resume listing.
1723
1973
  # @param [String] status
1724
- # The type of files in the version that should be listed.
1974
+ # The type of files that should be listed for the specified version.
1725
1975
  # @param [String] fields
1726
1976
  # Selector specifying which fields to include in a partial response.
1727
1977
  # @param [String] quota_user