google-apis-firebasehosting_v1beta1 0.2.0 → 0.7.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 844401c7c68444118d1899dbaf94e935379797e0ba22c708392106abafa8831f
4
- data.tar.gz: 5cfeef0f4c7d1bd1da4ac70fdc86f5c487ace7d561417869e77ebf038fb156a3
3
+ metadata.gz: d13082e31ada010d1892545b2d083b9de3854dfc01bc4cc845592ac06df87178
4
+ data.tar.gz: 2e6e1f821ccf5977b8014267bfe506e5b92f6071e4faf86b648896dc7d58c6ed
5
5
  SHA512:
6
- metadata.gz: 3e24c6adfb7ceccd8c5f85074104e54db63ed2f5f3c91d06e7583aa0d41d44b715088e14cac96cfc86d7e07ee872d0c10ddc57b2b16c7f9a428636a89247a34b
7
- data.tar.gz: 29d99d40d2059c79a642b8215bdddf30f6dfedd19bd95f7759fdbef2c7fedb9e603fb6cdcf5bda7e7cbfd5ef705bf0e880e746448f6135323772520e770c860e
6
+ metadata.gz: c1fb2865cadac506533837ff29edc85b1611e07ce19861fc57ab1e15d57fe31abc3174e7a05167ba8ddf76f887187b96d5cfc517741cd1d4b0b75a47ddd28bb0
7
+ data.tar.gz: c013fbe266d41b8dd149decfb7c77afdff0661266d27540cd40855d5459ed79339dac9ef7b0461dd543ee7baeb8b836e1c4d2038a8ff2c70edeba85c7d4d68f2
data/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Release history for google-apis-firebasehosting_v1beta1
2
2
 
3
+ ### v0.7.0 (2021-05-19)
4
+
5
+ * Unspecified changes
6
+
7
+ ### v0.6.0 (2021-04-20)
8
+
9
+ * Regenerated from discovery document revision 20210415
10
+
11
+ ### v0.5.0 (2021-03-16)
12
+
13
+ * Regenerated from discovery document revision 20210315
14
+
15
+ ### v0.4.0 (2021-03-12)
16
+
17
+ * Regenerated from discovery document revision 20210311
18
+ * Regenerated using generator version 0.2.0
19
+
20
+ ### v0.3.0 (2021-03-04)
21
+
22
+ * Regenerated from discovery document revision 20210303
23
+
3
24
  ### v0.2.0 (2021-02-02)
4
25
 
5
26
  * Regenerated from discovery document revision 20210129
@@ -21,9 +21,10 @@ module Google
21
21
  module Apis
22
22
  # Firebase Hosting API
23
23
  #
24
- # The Firebase Hosting REST API enables programmatic and customizable
25
- # deployments to your Firebase-hosted sites. Use this REST API to deploy new or
26
- # updated hosting configurations and content files.
24
+ # The Firebase Hosting REST API enables programmatic and customizable management
25
+ # and deployments to your Firebase-hosted sites. Use this REST API to create and
26
+ # manage channels and sites as well as to deploy new or updated hosting
27
+ # configurations and content files.
27
28
  #
28
29
  # @see https://firebase.google.com/docs/hosting/
29
30
  module FirebasehostingV1beta1
@@ -31,7 +32,7 @@ module Google
31
32
  # This is NOT the gem version.
32
33
  VERSION = 'V1beta1'
33
34
 
34
- # View and manage your data across Google Cloud Platform services
35
+ # See, edit, configure, and delete your Google Cloud Platform data
35
36
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
36
37
 
37
38
  # View your data across Google Cloud Platform services
@@ -103,8 +103,8 @@ module Google
103
103
  end
104
104
 
105
105
  # A `Channel` represents a stream of releases for a site. All sites have a
106
- # default `live` channel that serves content to the live Firebase-provided
107
- # domains and any connected custom domains.
106
+ # default `live` channel that serves content to the Firebase-provided subdomains
107
+ # and any connected custom domains.
108
108
  class Channel
109
109
  include Google::Apis::Core::Hashable
110
110
 
@@ -114,8 +114,8 @@ module Google
114
114
  attr_accessor :create_time
115
115
 
116
116
  # The time at which the channel will be automatically deleted. If null, the
117
- # channel will not be automatically deleted. This field is present in output
118
- # whether set directly or via the `ttl` field.
117
+ # channel will not be automatically deleted. This field is present in the output
118
+ # whether it's set directly or via the `ttl` field.
119
119
  # Corresponds to the JSON property `expireTime`
120
120
  # @return [String]
121
121
  attr_accessor :expire_time
@@ -125,7 +125,8 @@ module Google
125
125
  # @return [Hash<String,String>]
126
126
  attr_accessor :labels
127
127
 
128
- # The fully-qualified identifier of the Channel.
128
+ # The fully-qualified resource name for the channel, in the format: sites/
129
+ # SITE_ID/channels/CHANNEL_ID
129
130
  # Corresponds to the JSON property `name`
130
131
  # @return [String]
131
132
  attr_accessor :name
@@ -153,8 +154,12 @@ module Google
153
154
  # @return [String]
154
155
  attr_accessor :update_time
155
156
 
156
- # Output only. The URL at which the channel can be viewed. For the `live`
157
- # channel, the content of the current release may also be visible at other URLs.
157
+ # Output only. The URL at which the content of this channel's current release
158
+ # can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The
159
+ # content of this channel's current release can also be viewed at the Firebase-
160
+ # provided subdomain of `firebaseapp.com`. If this channel is the `live` channel
161
+ # for the Hosting site, then the content of this channel's current release can
162
+ # also be viewed at any connected custom domains.
158
163
  # Corresponds to the JSON property `url`
159
164
  # @return [String]
160
165
  attr_accessor :url
@@ -177,7 +182,7 @@ module Google
177
182
  end
178
183
  end
179
184
 
180
- # The request sent to CloneVersion.
185
+ #
181
186
  class CloneVersionRequest
182
187
  include Google::Apis::Core::Hashable
183
188
 
@@ -186,7 +191,10 @@ module Google
186
191
  # @return [Google::Apis::FirebasehostingV1beta1::PathFilter]
187
192
  attr_accessor :exclude
188
193
 
189
- # If true, immediately finalize the version after cloning is complete.
194
+ # If true, the call to `CloneVersion` immediately finalizes the version after
195
+ # cloning is complete. If false, the cloned version will have a status of `
196
+ # CREATED`. Use [`UpdateVersion`](patch) to set the status of the version to `
197
+ # FINALIZED`.
190
198
  # Corresponds to the JSON property `finalize`
191
199
  # @return [Boolean]
192
200
  attr_accessor :finalize
@@ -197,8 +205,8 @@ module Google
197
205
  # @return [Google::Apis::FirebasehostingV1beta1::PathFilter]
198
206
  attr_accessor :include
199
207
 
200
- # Required. The name of the version to be cloned, in the format: `sites/`site`/
201
- # versions/`version``
208
+ # Required. The unique identifier for the version to be cloned, in the format:
209
+ # sites/SITE_ID/versions/VERSION_ID
202
210
  # Corresponds to the JSON property `sourceVersion`
203
211
  # @return [String]
204
212
  attr_accessor :source_version
@@ -458,7 +466,7 @@ module Google
458
466
  end
459
467
  end
460
468
 
461
- # The response returned by ListChannels.
469
+ #
462
470
  class ListChannelsResponse
463
471
  include Google::Apis::Core::Hashable
464
472
 
@@ -467,9 +475,9 @@ module Google
467
475
  # @return [Array<Google::Apis::FirebasehostingV1beta1::Channel>]
468
476
  attr_accessor :channels
469
477
 
470
- # If there are additional releases remaining beyond the ones in this response,
471
- # then supply this token in the next [`list`](../sites.channels/list) call to
472
- # continue with the next set of releases.
478
+ # The pagination token, if more results exist beyond the ones in this response.
479
+ # Include this token in your next call to `ListChannels`. Page tokens are short-
480
+ # lived and should not be stored.
473
481
  # Corresponds to the JSON property `nextPageToken`
474
482
  # @return [String]
475
483
  attr_accessor :next_page_token
@@ -537,6 +545,33 @@ module Google
537
545
  end
538
546
  end
539
547
 
548
+ #
549
+ class ListSitesResponse
550
+ include Google::Apis::Core::Hashable
551
+
552
+ # The pagination token, if more results exist beyond the ones in this response.
553
+ # Include this token in your next call to `ListSites`. Page tokens are short-
554
+ # lived and should not be stored.
555
+ # Corresponds to the JSON property `nextPageToken`
556
+ # @return [String]
557
+ attr_accessor :next_page_token
558
+
559
+ # A list of Site objects associated with the specified Firebase project.
560
+ # Corresponds to the JSON property `sites`
561
+ # @return [Array<Google::Apis::FirebasehostingV1beta1::Site>]
562
+ attr_accessor :sites
563
+
564
+ def initialize(**args)
565
+ update!(**args)
566
+ end
567
+
568
+ # Update properties of this object
569
+ def update!(**args)
570
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
571
+ @sites = args[:sites] if args.key?(:sites)
572
+ end
573
+ end
574
+
540
575
  #
541
576
  class ListVersionFilesResponse
542
577
  include Google::Apis::Core::Hashable
@@ -568,7 +603,9 @@ module Google
568
603
  class ListVersionsResponse
569
604
  include Google::Apis::Core::Hashable
570
605
 
571
- # The pagination token, if more results exist
606
+ # The pagination token, if more results exist beyond the ones in this response.
607
+ # Include this token in your next call to `ListVersions`. Page tokens are short-
608
+ # lived and should not be stored.
572
609
  # Corresponds to the JSON property `nextPageToken`
573
610
  # @return [String]
574
611
  attr_accessor :next_page_token
@@ -655,7 +692,7 @@ module Google
655
692
  class PathFilter
656
693
  include Google::Apis::Core::Hashable
657
694
 
658
- # An array of regexes to filter by.
695
+ # An array of RegEx values by which to filter.
659
696
  # Corresponds to the JSON property `regexes`
660
697
  # @return [Array<String>]
661
698
  attr_accessor :regexes
@@ -703,9 +740,9 @@ module Google
703
740
  attr_accessor :upload_required_hashes
704
741
 
705
742
  # The URL to which the files should be uploaded, in the format: "https://upload-
706
- # firebasehosting.googleapis.com/upload/sites/SITE_NAME /versions/VERSION_ID/
707
- # files" Perform a multipart `POST` of the Gzipped file contents to the URL
708
- # using a forward slash and the hash of the file appended to the end.
743
+ # firebasehosting.googleapis.com/upload/sites/SITE_ID /versions/VERSION_ID/files"
744
+ # Perform a multipart `POST` of the Gzipped file contents to the URL using a
745
+ # forward slash and the hash of the file appended to the end.
709
746
  # Corresponds to the JSON property `uploadUrl`
710
747
  # @return [String]
711
748
  attr_accessor :upload_url
@@ -721,9 +758,7 @@ module Google
721
758
  end
722
759
  end
723
760
 
724
- # Version preview configuration. If active and unexpired, this version will be
725
- # accessible via a custom URL even if it is not the currently released version.
726
- # Deprecated in favor of site channels.
761
+ # Deprecated in favor of [site channels](sites.channels).
727
762
  class PreviewConfig
728
763
  include Google::Apis::Core::Hashable
729
764
 
@@ -806,9 +841,11 @@ module Google
806
841
  # @return [String]
807
842
  attr_accessor :message
808
843
 
809
- # Output only. The unique identifier for the release, in the format: sites/
810
- # SITE_NAME/releases/RELEASE_ID This name is provided in the response body when
811
- # you call [`CreateRelease`](sites.releases/create).
844
+ # Output only. The unique identifier for the release, in either of the following
845
+ # formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/
846
+ # CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when
847
+ # you call [`releases.create`](sites.releases/create) or [`channels.releases.
848
+ # create`](sites.channels.releases/create).
812
849
  # Corresponds to the JSON property `name`
813
850
  # @return [String]
814
851
  attr_accessor :name
@@ -975,6 +1012,60 @@ module Google
975
1012
  end
976
1013
  end
977
1014
 
1015
+ # A `Site` represents a Firebase Hosting site.
1016
+ class Site
1017
+ include Google::Apis::Core::Hashable
1018
+
1019
+ # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/
1020
+ # reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with
1021
+ # the Hosting site.
1022
+ # Corresponds to the JSON property `appId`
1023
+ # @return [String]
1024
+ attr_accessor :app_id
1025
+
1026
+ # Output only. The default URL for the Hosting site.
1027
+ # Corresponds to the JSON property `defaultUrl`
1028
+ # @return [String]
1029
+ attr_accessor :default_url
1030
+
1031
+ # Optional. User-specified labels for the Hosting site.
1032
+ # Corresponds to the JSON property `labels`
1033
+ # @return [Hash<String,String>]
1034
+ attr_accessor :labels
1035
+
1036
+ # Output only. The fully-qualified resource name of the Hosting site, in the
1037
+ # format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the
1038
+ # Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/
1039
+ # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(
1040
+ # recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/
1041
+ # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn
1042
+ # more about using project identifiers in Google's [AIP 2510 standard](https://
1043
+ # google.aip.dev/cloud/2510).
1044
+ # Corresponds to the JSON property `name`
1045
+ # @return [String]
1046
+ attr_accessor :name
1047
+
1048
+ # Output only. The type of Hosting site. Every Firebase project has a `
1049
+ # DEFAULT_SITE`, which is created when Hosting is provisioned for the project.
1050
+ # All additional sites are `USER_SITE`.
1051
+ # Corresponds to the JSON property `type`
1052
+ # @return [String]
1053
+ attr_accessor :type
1054
+
1055
+ def initialize(**args)
1056
+ update!(**args)
1057
+ end
1058
+
1059
+ # Update properties of this object
1060
+ def update!(**args)
1061
+ @app_id = args[:app_id] if args.key?(:app_id)
1062
+ @default_url = args[:default_url] if args.key?(:default_url)
1063
+ @labels = args[:labels] if args.key?(:labels)
1064
+ @name = args[:name] if args.key?(:name)
1065
+ @type = args[:type] if args.key?(:type)
1066
+ end
1067
+ end
1068
+
978
1069
  # A `SiteConfig` contains metadata associated with a specific site that controls
979
1070
  # Firebase Hosting serving behavior
980
1071
  class SiteConfig
@@ -1103,28 +1194,26 @@ module Google
1103
1194
  # @return [Hash<String,String>]
1104
1195
  attr_accessor :labels
1105
1196
 
1106
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
1107
- # VERSION_ID This name is provided in the response body when you call [`
1108
- # CreateVersion`](sites.versions/create).
1197
+ # The fully-qualified resource name for the version, in the format: sites/
1198
+ # SITE_ID/versions/VERSION_ID This name is provided in the response body when
1199
+ # you call [`CreateVersion`](sites.versions/create).
1109
1200
  # Corresponds to the JSON property `name`
1110
1201
  # @return [String]
1111
1202
  attr_accessor :name
1112
1203
 
1113
- # Version preview configuration. If active and unexpired, this version will be
1114
- # accessible via a custom URL even if it is not the currently released version.
1115
- # Deprecated in favor of site channels.
1204
+ # Deprecated in favor of [site channels](sites.channels).
1116
1205
  # Corresponds to the JSON property `preview`
1117
1206
  # @return [Google::Apis::FirebasehostingV1beta1::PreviewConfig]
1118
1207
  attr_accessor :preview
1119
1208
 
1120
- # The deploy status of a version. For a successful deploy, call [`CreateVersion`]
1121
- # (sites.versions/create) to make a new version (`CREATED` status), [upload all
1122
- # desired files](sites.versions/populateFiles) to the version, then [update](
1123
- # sites.versions/patch) the version to the `FINALIZED` status. Note that if you
1124
- # leave the version in the `CREATED` state for more than 12 hours, the system
1125
- # will automatically mark the version as `ABANDONED`. You can also change the
1126
- # status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/
1127
- # delete).
1209
+ # The deploy status of the version. For a successful deploy, call [`
1210
+ # CreateVersion`](sites.versions/create) to make a new version (`CREATED` status)
1211
+ # , [upload all desired files](sites.versions/populateFiles) to the version,
1212
+ # then [update](sites.versions/patch) the version to the `FINALIZED` status.
1213
+ # Note that if you leave the version in the `CREATED` state for more than 12
1214
+ # hours, the system will automatically mark the version as `ABANDONED`. You can
1215
+ # also change the status of a version to `DELETED` by calling [`DeleteVersion`](
1216
+ # sites.versions/delete).
1128
1217
  # Corresponds to the JSON property `status`
1129
1218
  # @return [String]
1130
1219
  attr_accessor :status
@@ -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.2.0"
19
+ GEM_VERSION = "0.7.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.1.2"
22
+ GENERATOR_VERSION = "0.2.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20210129"
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.
@@ -328,14 +529,14 @@ module Google
328
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 to which the release belongs, in the format: sites/
332
- # SITE_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
- # VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME
337
- # in the `parent` parameter. This query parameter must be empty if the `type`
338
- # field in the request body is `SITE_DISABLE`.
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
538
+ # the `parent` parameter. This query parameter must be empty if the `type` field
539
+ # in the request body is `SITE_DISABLE`.
339
540
  # @param [String] fields
340
541
  # Selector specifying which fields to include in a partial response.
341
542
  # @param [String] quota_user
@@ -366,16 +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 site for which to list releases, 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
578
  # The maximum number of releases to return. The service may return a lower
374
579
  # number if fewer releases exist than this maximum number. If unspecified,
375
580
  # defaults to 100.
376
581
  # @param [String] page_token
377
- # A token from a previous call to `ListReleases` that tells the server where to
378
- # resume listing.
582
+ # A token from a previous call to `releases.list` or `channels.releases.list`
583
+ # that tells the server where to resume listing.
379
584
  # @param [String] fields
380
585
  # Selector specifying which fields to include in a partial response.
381
586
  # @param [String] quota_user
@@ -574,14 +779,14 @@ module Google
574
779
  # Creates a new release, which makes the content of the specified version
575
780
  # actively display on the appropriate URL(s).
576
781
  # @param [String] parent
577
- # Required. The site to which the release belongs, in the format: sites/
578
- # SITE_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
579
784
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
580
785
  # @param [String] version_name
581
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
582
- # VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME
583
- # in the `parent` parameter. This query parameter must be empty if the `type`
584
- # field in the request body is `SITE_DISABLE`.
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
788
+ # the `parent` parameter. This query parameter must be empty if the `type` field
789
+ # in the request body is `SITE_DISABLE`.
585
790
  # @param [String] fields
586
791
  # Selector specifying which fields to include in a partial response.
587
792
  # @param [String] quota_user
@@ -612,16 +817,20 @@ module Google
612
817
  execute_or_queue_command(command, &block)
613
818
  end
614
819
 
615
- # 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.
616
824
  # @param [String] parent
617
- # Required. The site for which to list releases, 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
618
827
  # @param [Fixnum] page_size
619
828
  # The maximum number of releases to return. The service may return a lower
620
829
  # number if fewer releases exist than this maximum number. If unspecified,
621
830
  # defaults to 100.
622
831
  # @param [String] page_token
623
- # A token from a previous call to `ListReleases` that tells the server where to
624
- # resume listing.
832
+ # A token from a previous call to `releases.list` or `channels.releases.list`
833
+ # that tells the server where to resume listing.
625
834
  # @param [String] fields
626
835
  # Selector specifying which fields to include in a partial response.
627
836
  # @param [String] quota_user
@@ -651,11 +860,11 @@ module Google
651
860
  execute_or_queue_command(command, &block)
652
861
  end
653
862
 
654
- # Creates a new version on the target site using the content of the specified
655
- # version.
863
+ # Creates a new version on the specified target site using the content of the
864
+ # specified version.
656
865
  # @param [String] parent
657
- # Required. The target site where the cloned version will reside, in the format:
658
- # `sites/`site``
866
+ # Required. The target site for the cloned version, in the format: sites/
867
+ # SITE_ID
659
868
  # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object
660
869
  # @param [String] fields
661
870
  # Selector specifying which fields to include in a partial response.
@@ -689,7 +898,7 @@ module Google
689
898
  # Creates a new version for the specified site.
690
899
  # @param [String] parent
691
900
  # Required. The site in which to create the version, in the format: sites/
692
- # SITE_NAME
901
+ # SITE_ID
693
902
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
694
903
  # @param [Fixnum] size_bytes
695
904
  # The self-reported size of the version. This value is used for a pre-emptive
@@ -730,8 +939,8 @@ module Google
730
939
 
731
940
  # Deletes the specified version.
732
941
  # @param [String] name
733
- # Required. The name of the version to be deleted, in the format: sites/
734
- # SITE_NAME/versions/VERSION_ID
942
+ # Required. The fully-qualified resource name for the version, in the format:
943
+ # sites/SITE_ID/versions/VERSION_ID
735
944
  # @param [String] fields
736
945
  # Selector specifying which fields to include in a partial response.
737
946
  # @param [String] quota_user
@@ -759,20 +968,25 @@ module Google
759
968
  execute_or_queue_command(command, &block)
760
969
  end
761
970
 
762
- # Lists the versions that have been created on the specified site. Will include
763
- # 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.
764
974
  # @param [String] parent
765
- # 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
766
977
  # @param [String] filter
767
- # The filter string used to return a subset of versions in the response.
768
- # Currently supported fields for filtering are: name, status, and create_time.
769
- # 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).
770
982
  # @param [Fixnum] page_size
771
- # The maximum number of versions to return. The service may return fewer than
772
- # this value. If unspecified, at most 25 versions will be returned. The maximum
773
- # 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.
774
987
  # @param [String] page_token
775
- # 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.
776
990
  # @param [String] fields
777
991
  # Selector specifying which fields to include in a partial response.
778
992
  # @param [String] quota_user
@@ -805,13 +1019,13 @@ module Google
805
1019
 
806
1020
  # Updates the specified metadata for the specified version. This method will
807
1021
  # fail with `FAILED_PRECONDITION` in the event of an invalid state transition.
808
- # The only valid transition for a version is currently from a `CREATED` status
809
- # to a `FINALIZED` status. Use [`DeleteVersion`](delete) to set the status of a
810
- # version to `DELETED`.
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`.
811
1025
  # @param [String] name
812
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
813
- # VERSION_ID This name is provided in the response body when you call [`
814
- # CreateVersion`](sites.versions/create).
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).
815
1029
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
816
1030
  # @param [String] update_mask
817
1031
  # A set of field names from your [version](../sites.versions) that you want to
@@ -850,7 +1064,7 @@ module Google
850
1064
 
851
1065
  # Adds content files to the specified version. Each file must be under 2 GB.
852
1066
  # @param [String] parent
853
- # Required. The version to which to add files, in the format: sites/SITE_NAME /
1067
+ # Required. The version to which to add files, in the format: sites/SITE_ID /
854
1068
  # versions/VERSION_ID
855
1069
  # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
856
1070
  # @param [String] fields
@@ -884,7 +1098,7 @@ module Google
884
1098
 
885
1099
  # Lists the remaining files to be uploaded for the specified version.
886
1100
  # @param [String] parent
887
- # Required. The version for which to list files, in the format: sites/ SITE_NAME/
1101
+ # Required. The version for which to list files, in the format: sites/SITE_ID /
888
1102
  # versions/VERSION_ID
889
1103
  # @param [Fixnum] page_size
890
1104
  # The maximum number of version files to return. The service may return a lower
@@ -998,10 +1212,11 @@ module Google
998
1212
 
999
1213
  # Creates a new channel in the specified site.
1000
1214
  # @param [String] parent
1001
- # 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
1002
1217
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
1003
1218
  # @param [String] channel_id
1004
- # 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.
1005
1220
  # @param [String] fields
1006
1221
  # Selector specifying which fields to include in a partial response.
1007
1222
  # @param [String] quota_user
@@ -1032,9 +1247,11 @@ module Google
1032
1247
  execute_or_queue_command(command, &block)
1033
1248
  end
1034
1249
 
1035
- # 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.
1036
1252
  # @param [String] name
1037
- # 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
1038
1255
  # @param [String] fields
1039
1256
  # Selector specifying which fields to include in a partial response.
1040
1257
  # @param [String] quota_user
@@ -1062,9 +1279,10 @@ module Google
1062
1279
  execute_or_queue_command(command, &block)
1063
1280
  end
1064
1281
 
1065
- # Retrieves information for the specified channel of a site.
1282
+ # Retrieves information for the specified channel of the specified site.
1066
1283
  # @param [String] name
1067
- # 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
1068
1286
  # @param [String] fields
1069
1287
  # Selector specifying which fields to include in a partial response.
1070
1288
  # @param [String] quota_user
@@ -1092,16 +1310,18 @@ module Google
1092
1310
  execute_or_queue_command(command, &block)
1093
1311
  end
1094
1312
 
1095
- # 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`
1096
1314
  # channel.
1097
1315
  # @param [String] parent
1098
- # Required. The site from which to list channels.
1316
+ # Required. The site for which to list channels, in the format: sites/SITE_ID
1099
1317
  # @param [Fixnum] page_size
1100
- # The maximum number of versions to return. The service may return fewer than
1101
- # this value. If unspecified, at most 25 channels will be returned. The maximum
1102
- # 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.
1103
1322
  # @param [String] page_token
1104
- # 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.
1105
1325
  # @param [String] fields
1106
1326
  # Selector specifying which fields to include in a partial response.
1107
1327
  # @param [String] quota_user
@@ -1131,10 +1351,11 @@ module Google
1131
1351
  execute_or_queue_command(command, &block)
1132
1352
  end
1133
1353
 
1134
- # Updates information for the specified channel of a site. This method will
1135
- # 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.
1136
1356
  # @param [String] name
1137
- # 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
1138
1359
  # @param [Google::Apis::FirebasehostingV1beta1::Channel] channel_object
1139
1360
  # @param [String] update_mask
1140
1361
  # A comma-separated list of fields to be updated in this request.
@@ -1171,14 +1392,14 @@ module Google
1171
1392
  # Creates a new release, which makes the content of the specified version
1172
1393
  # actively display on the appropriate URL(s).
1173
1394
  # @param [String] parent
1174
- # Required. The site to which the release belongs, in the format: sites/
1175
- # SITE_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
1176
1397
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
1177
1398
  # @param [String] version_name
1178
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
1179
- # VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME
1180
- # in the `parent` parameter. This query parameter must be empty if the `type`
1181
- # field in the request body is `SITE_DISABLE`.
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
1401
+ # the `parent` parameter. This query parameter must be empty if the `type` field
1402
+ # in the request body is `SITE_DISABLE`.
1182
1403
  # @param [String] fields
1183
1404
  # Selector specifying which fields to include in a partial response.
1184
1405
  # @param [String] quota_user
@@ -1209,16 +1430,20 @@ module Google
1209
1430
  execute_or_queue_command(command, &block)
1210
1431
  end
1211
1432
 
1212
- # 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.
1213
1437
  # @param [String] parent
1214
- # Required. The site for which to list releases, 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
1215
1440
  # @param [Fixnum] page_size
1216
1441
  # The maximum number of releases to return. The service may return a lower
1217
1442
  # number if fewer releases exist than this maximum number. If unspecified,
1218
1443
  # defaults to 100.
1219
1444
  # @param [String] page_token
1220
- # A token from a previous call to `ListReleases` that tells the server where to
1221
- # resume listing.
1445
+ # A token from a previous call to `releases.list` or `channels.releases.list`
1446
+ # that tells the server where to resume listing.
1222
1447
  # @param [String] fields
1223
1448
  # Selector specifying which fields to include in a partial response.
1224
1449
  # @param [String] quota_user
@@ -1417,14 +1642,14 @@ module Google
1417
1642
  # Creates a new release, which makes the content of the specified version
1418
1643
  # actively display on the appropriate URL(s).
1419
1644
  # @param [String] parent
1420
- # Required. The site to which the release belongs, in the format: sites/
1421
- # SITE_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
1422
1647
  # @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
1423
1648
  # @param [String] version_name
1424
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
1425
- # VERSION_ID The SITE_NAME in this version identifier must match the SITE_NAME
1426
- # in the `parent` parameter. This query parameter must be empty if the `type`
1427
- # field in the request body is `SITE_DISABLE`.
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
1651
+ # the `parent` parameter. This query parameter must be empty if the `type` field
1652
+ # in the request body is `SITE_DISABLE`.
1428
1653
  # @param [String] fields
1429
1654
  # Selector specifying which fields to include in a partial response.
1430
1655
  # @param [String] quota_user
@@ -1455,16 +1680,20 @@ module Google
1455
1680
  execute_or_queue_command(command, &block)
1456
1681
  end
1457
1682
 
1458
- # 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.
1459
1687
  # @param [String] parent
1460
- # Required. The site for which to list releases, 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
1461
1690
  # @param [Fixnum] page_size
1462
1691
  # The maximum number of releases to return. The service may return a lower
1463
1692
  # number if fewer releases exist than this maximum number. If unspecified,
1464
1693
  # defaults to 100.
1465
1694
  # @param [String] page_token
1466
- # A token from a previous call to `ListReleases` that tells the server where to
1467
- # resume listing.
1695
+ # A token from a previous call to `releases.list` or `channels.releases.list`
1696
+ # that tells the server where to resume listing.
1468
1697
  # @param [String] fields
1469
1698
  # Selector specifying which fields to include in a partial response.
1470
1699
  # @param [String] quota_user
@@ -1494,11 +1723,11 @@ module Google
1494
1723
  execute_or_queue_command(command, &block)
1495
1724
  end
1496
1725
 
1497
- # Creates a new version on the target site using the content of the specified
1498
- # version.
1726
+ # Creates a new version on the specified target site using the content of the
1727
+ # specified version.
1499
1728
  # @param [String] parent
1500
- # Required. The target site where the cloned version will reside, in the format:
1501
- # `sites/`site``
1729
+ # Required. The target site for the cloned version, in the format: sites/
1730
+ # SITE_ID
1502
1731
  # @param [Google::Apis::FirebasehostingV1beta1::CloneVersionRequest] clone_version_request_object
1503
1732
  # @param [String] fields
1504
1733
  # Selector specifying which fields to include in a partial response.
@@ -1532,7 +1761,7 @@ module Google
1532
1761
  # Creates a new version for the specified site.
1533
1762
  # @param [String] parent
1534
1763
  # Required. The site in which to create the version, in the format: sites/
1535
- # SITE_NAME
1764
+ # SITE_ID
1536
1765
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
1537
1766
  # @param [Fixnum] size_bytes
1538
1767
  # The self-reported size of the version. This value is used for a pre-emptive
@@ -1573,8 +1802,8 @@ module Google
1573
1802
 
1574
1803
  # Deletes the specified version.
1575
1804
  # @param [String] name
1576
- # Required. The name of the version to be deleted, in the format: sites/
1577
- # SITE_NAME/versions/VERSION_ID
1805
+ # Required. The fully-qualified resource name for the version, in the format:
1806
+ # sites/SITE_ID/versions/VERSION_ID
1578
1807
  # @param [String] fields
1579
1808
  # Selector specifying which fields to include in a partial response.
1580
1809
  # @param [String] quota_user
@@ -1602,20 +1831,25 @@ module Google
1602
1831
  execute_or_queue_command(command, &block)
1603
1832
  end
1604
1833
 
1605
- # Lists the versions that have been created on the specified site. Will include
1606
- # 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.
1607
1837
  # @param [String] parent
1608
- # 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
1609
1840
  # @param [String] filter
1610
- # The filter string used to return a subset of versions in the response.
1611
- # Currently supported fields for filtering are: name, status, and create_time.
1612
- # 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).
1613
1845
  # @param [Fixnum] page_size
1614
- # The maximum number of versions to return. The service may return fewer than
1615
- # this value. If unspecified, at most 25 versions will be returned. The maximum
1616
- # 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.
1617
1850
  # @param [String] page_token
1618
- # 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.
1619
1853
  # @param [String] fields
1620
1854
  # Selector specifying which fields to include in a partial response.
1621
1855
  # @param [String] quota_user
@@ -1648,13 +1882,13 @@ module Google
1648
1882
 
1649
1883
  # Updates the specified metadata for the specified version. This method will
1650
1884
  # fail with `FAILED_PRECONDITION` in the event of an invalid state transition.
1651
- # The only valid transition for a version is currently from a `CREATED` status
1652
- # to a `FINALIZED` status. Use [`DeleteVersion`](delete) to set the status of a
1653
- # version to `DELETED`.
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`.
1654
1888
  # @param [String] name
1655
- # The unique identifier for a version, in the format: sites/SITE_NAME /versions/
1656
- # VERSION_ID This name is provided in the response body when you call [`
1657
- # CreateVersion`](sites.versions/create).
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).
1658
1892
  # @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
1659
1893
  # @param [String] update_mask
1660
1894
  # A set of field names from your [version](../sites.versions) that you want to
@@ -1693,7 +1927,7 @@ module Google
1693
1927
 
1694
1928
  # Adds content files to the specified version. Each file must be under 2 GB.
1695
1929
  # @param [String] parent
1696
- # Required. The version to which to add files, in the format: sites/SITE_NAME /
1930
+ # Required. The version to which to add files, in the format: sites/SITE_ID /
1697
1931
  # versions/VERSION_ID
1698
1932
  # @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
1699
1933
  # @param [String] fields
@@ -1727,7 +1961,7 @@ module Google
1727
1961
 
1728
1962
  # Lists the remaining files to be uploaded for the specified version.
1729
1963
  # @param [String] parent
1730
- # Required. The version for which to list files, in the format: sites/ SITE_NAME/
1964
+ # Required. The version for which to list files, in the format: sites/SITE_ID /
1731
1965
  # versions/VERSION_ID
1732
1966
  # @param [Fixnum] page_size
1733
1967
  # The maximum number of version files to return. The service may return a lower
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-firebasehosting_v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-02-08 00:00:00.000000000 Z
11
+ date: 2021-05-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -52,7 +52,7 @@ licenses:
52
52
  metadata:
53
53
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
54
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebasehosting_v1beta1/CHANGELOG.md
55
- documentation_uri: https://googleapis.dev/ruby/google-apis-firebasehosting_v1beta1/v0.2.0
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firebasehosting_v1beta1/v0.7.0
56
56
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-firebasehosting_v1beta1
57
57
  post_install_message:
58
58
  rdoc_options: []
@@ -62,14 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
62
62
  requirements:
63
63
  - - ">="
64
64
  - !ruby/object:Gem::Version
65
- version: '2.4'
65
+ version: '2.5'
66
66
  required_rubygems_version: !ruby/object:Gem::Requirement
67
67
  requirements:
68
68
  - - ">="
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  requirements: []
72
- rubygems_version: 3.2.6
72
+ rubygems_version: 3.2.17
73
73
  signing_key:
74
74
  specification_version: 4
75
75
  summary: Simple REST client for Firebase Hosting API V1beta1