google-apis-firebasehosting_v1beta1 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71a982cf3233fc9991606f5e35533ca8c1b79205943a1df9e354e736aed2b95e
-  data.tar.gz: 1a0a71c6f287c1c437b5396fcd168548a3302b17bc7a5307d3028f8f105638d5
+  metadata.gz: c2b3328db615c6142acbe6f92b732701067d70062403add2a46c04e2761a73c8
+  data.tar.gz: c4408ec709d3c4f0b3c1af81baba96430ffb1714fca27f0916e713472a1029c5
 SHA512:
-  metadata.gz: ab5f5d56fec64fb01f68c0e9765e37ee444e0c0e341b792e886f86f8f581e42e455fe3f3a71e882dac4d7a906f521afc5fa7871bc86f20cd4adad536a0f262eb
-  data.tar.gz: 708ee4a905001e87cadde850e24a2c15e3b798465cd5294fdeacdcf64213a48700b959b20f2daa56ea4ec4a84ae5fcf1d5ce5788099679345d52adcf22558771
+  metadata.gz: 88448afe99de008a6eefa01c029bc9bf202902c0e6692030f61fadb3956f56e03a79f6f6bb435adb3a2405f5cf48728436afb21eead9799fea45f66e0fb9b495
+  data.tar.gz: '084fed1faf7235c70f25b07f4630a44c91f9cf6be06f0980cdf47df188c6f44a993317c7b77121eb263bcde8a7106c038061b95efa345f1dc989c702606238f8'

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release history for google-apis-firebasehosting_v1beta1
 
+### v0.6.0 (2021-04-20)
+
+* Regenerated from discovery document revision 20210415
+
+### v0.5.0 (2021-03-16)
+
+* Regenerated from discovery document revision 20210315
+
+### v0.4.0 (2021-03-12)
+
+* Regenerated from discovery document revision 20210311
+* Regenerated using generator version 0.2.0
+
+### v0.3.0 (2021-03-04)
+
+* Regenerated from discovery document revision 20210303
+
+### v0.2.0 (2021-02-02)
+
+* Regenerated from discovery document revision 20210129
+* Regenerated using generator version 0.1.2
+
 ### v0.1.0 (2021-01-07)
 
 * Regenerated using generator version 0.1.1

data/lib/google/apis/firebasehosting_v1beta1.rb

@@ -21,9 +21,10 @@ module Google
   module Apis
     # Firebase Hosting API
     #
-    # The Firebase Hosting REST API enables programmatic and customizable
-    # deployments to your Firebase-hosted sites. Use this REST API to deploy new or
-    # updated hosting configurations and content files.
+    # The Firebase Hosting REST API enables programmatic and customizable management
+    # and deployments to your Firebase-hosted sites. Use this REST API to create and
+    # manage channels and sites as well as to deploy new or updated hosting
+    # configurations and content files.
     #
     # @see https://firebase.google.com/docs/hosting/
     module FirebasehostingV1beta1
@@ -31,7 +32,7 @@ module Google
       # This is NOT the gem version.
       VERSION = 'V1beta1'
 
-      # View and manage your data across Google Cloud Platform services
+      # See, edit, configure, and delete your Google Cloud Platform data
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
 
       # View your data across Google Cloud Platform services

data/lib/google/apis/firebasehosting_v1beta1/classes.rb

@@ -103,8 +103,8 @@ module Google
       end
       
       # A `Channel` represents a stream of releases for a site. All sites have a
-      # default `live` channel that serves content to the live Firebase-provided
-      # domains and any connected custom domains.
+      # default `live` channel that serves content to the Firebase-provided subdomains
+      # and any connected custom domains.
       class Channel
         include Google::Apis::Core::Hashable
       
@@ -114,8 +114,8 @@ module Google
         attr_accessor :create_time
       
         # The time at which the channel will be automatically deleted. If null, the
-        # channel will not be automatically deleted. This field is present in output
-        # whether set directly or via the `ttl` field.
+        # channel will not be automatically deleted. This field is present in the output
+        # whether it's set directly or via the `ttl` field.
         # Corresponds to the JSON property `expireTime`
         # @return [String]
         attr_accessor :expire_time
@@ -125,7 +125,8 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :labels
       
-        # The fully-qualified identifier of the Channel.
+        # The fully-qualified resource name for the channel, in the format: sites/
+        # SITE_ID/channels/CHANNEL_ID
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -153,8 +154,12 @@ module Google
         # @return [String]
         attr_accessor :update_time
       
-        # Output only. The URL at which the channel can be viewed. For the `live`
-        # channel, the content of the current release may also be visible at other URLs.
+        # Output only. The URL at which the content of this channel's current release
+        # can be viewed. This URL is a Firebase-provided subdomain of `web.app`. The
+        # content of this channel's current release can also be viewed at the Firebase-
+        # provided subdomain of `firebaseapp.com`. If this channel is the `live` channel
+        # for the Hosting site, then the content of this channel's current release can
+        # also be viewed at any connected custom domains.
         # Corresponds to the JSON property `url`
         # @return [String]
         attr_accessor :url
@@ -177,7 +182,7 @@ module Google
         end
       end
       
-      # The request sent to CloneVersion.
+      # 
       class CloneVersionRequest
         include Google::Apis::Core::Hashable
       
@@ -186,7 +191,10 @@ module Google
         # @return [Google::Apis::FirebasehostingV1beta1::PathFilter]
         attr_accessor :exclude
       
-        # If true, immediately finalize the version after cloning is complete.
+        # If true, the call to `CloneVersion` immediately finalizes the version after
+        # cloning is complete. If false, the cloned version will have a status of `
+        # CREATED`. Use [`UpdateVersion`](patch) to set the status of the version to `
+        # FINALIZED`.
         # Corresponds to the JSON property `finalize`
         # @return [Boolean]
         attr_accessor :finalize
@@ -197,8 +205,8 @@ module Google
         # @return [Google::Apis::FirebasehostingV1beta1::PathFilter]
         attr_accessor :include
       
-        # Required. The name of the version to be cloned, in the format: `sites/`site`/
-        # versions/`version``
+        # Required. The unique identifier for the version to be cloned, in the format:
+        # sites/SITE_ID/versions/VERSION_ID
         # Corresponds to the JSON property `sourceVersion`
         # @return [String]
         attr_accessor :source_version
@@ -404,14 +412,14 @@ module Google
         end
       end
       
-      # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a
-      # URL pattern that, if matched to the request URL path, triggers Hosting to
-      # apply the specified custom response headers.
+      # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers)
+      # specifies a URL pattern that, if matched to the request URL path, triggers
+      # Hosting to apply the specified custom response headers.
       class Header
         include Google::Apis::Core::Hashable
       
-        # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
-        # match against the request URL path.
+        # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#
+        # glob_pattern_matching) to match against the request URL path.
         # Corresponds to the JSON property `glob`
         # @return [String]
         attr_accessor :glob
@@ -458,7 +466,7 @@ module Google
         end
       end
       
-      # The response returned by ListChannels.
+      # 
       class ListChannelsResponse
         include Google::Apis::Core::Hashable
       
@@ -467,9 +475,9 @@ module Google
         # @return [Array<Google::Apis::FirebasehostingV1beta1::Channel>]
         attr_accessor :channels
       
-        # If there are additional releases remaining beyond the ones in this response,
-        # then supply this token in the next [`list`](../sites.channels/list) call to
-        # continue with the next set of releases.
+        # The pagination token, if more results exist beyond the ones in this response.
+        # Include this token in your next call to `ListChannels`. Page tokens are short-
+        # lived and should not be stored.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
@@ -514,9 +522,9 @@ module Google
       class ListReleasesResponse
         include Google::Apis::Core::Hashable
       
-        # If there are additional releases remaining beyond the ones in this response,
-        # then supply this token in the next [`list`](../sites.versions.files/list) call
-        # to continue with the next set of releases.
+        # The pagination token, if more results exist beyond the ones in this response.
+        # Include this token in your next call to `ListReleases`. Page tokens are short-
+        # lived and should not be stored.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
@@ -537,16 +545,45 @@ module Google
         end
       end
       
+      # 
+      class ListSitesResponse
+        include Google::Apis::Core::Hashable
+      
+        # The pagination token, if more results exist beyond the ones in this response.
+        # Include this token in your next call to `ListSites`. Page tokens are short-
+        # lived and should not be stored.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # A list of Site objects associated with the specified Firebase project.
+        # Corresponds to the JSON property `sites`
+        # @return [Array<Google::Apis::FirebasehostingV1beta1::Site>]
+        attr_accessor :sites
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @sites = args[:sites] if args.key?(:sites)
+        end
+      end
+      
       # 
       class ListVersionFilesResponse
         include Google::Apis::Core::Hashable
       
-        # The list path/hashes in the specified version.
+        # The list of paths to the hashes of the files in the specified version.
         # Corresponds to the JSON property `files`
         # @return [Array<Google::Apis::FirebasehostingV1beta1::VersionFile>]
         attr_accessor :files
       
-        # The pagination token, if more results exist.
+        # The pagination token, if more results exist beyond the ones in this response.
+        # Include this token in your next call to `ListVersionFiles`. Page tokens are
+        # short-lived and should not be stored.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
@@ -566,7 +603,9 @@ module Google
       class ListVersionsResponse
         include Google::Apis::Core::Hashable
       
-        # The pagination token, if more results exist
+        # The pagination token, if more results exist beyond the ones in this response.
+        # Include this token in your next call to `ListVersions`. Page tokens are short-
+        # lived and should not be stored.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token
@@ -653,7 +692,7 @@ module Google
       class PathFilter
         include Google::Apis::Core::Hashable
       
-        # An array of regexes to filter by.
+        # An array of RegEx values by which to filter.
         # Corresponds to the JSON property `regexes`
         # @return [Array<String>]
         attr_accessor :regexes
@@ -668,14 +707,14 @@ module Google
         end
       end
       
-      # The request to populate a Version's Files.
+      # 
       class PopulateVersionFilesRequest
         include Google::Apis::Core::Hashable
       
         # A set of file paths to the hashes corresponding to assets that should be added
-        # to the version. Note that a file path to an empty hash will remove the path
-        # from the version. Calculate a hash by Gzipping the file then taking the SHA256
-        # hash of the newly compressed file.
+        # to the version. A file path to an empty hash will remove the path from the
+        # version. Calculate a hash by Gzipping the file then taking the SHA256 hash of
+        # the newly compressed file.
         # Corresponds to the JSON property `files`
         # @return [Hash<String,String>]
         attr_accessor :files
@@ -695,15 +734,15 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The content hashes of the specified files that need to be uploaded to the
-        # specified endpoint.
+        # specified URL.
         # Corresponds to the JSON property `uploadRequiredHashes`
         # @return [Array<String>]
         attr_accessor :upload_required_hashes
       
         # The URL to which the files should be uploaded, in the format: "https://upload-
-        # firebasehosting.googleapis.com/upload/sites/site-name /versions/versionID/
-        # files". Perform a multipart `POST` of the Gzipped file contents to the URL
-        # using a forward slash and the hash of the file appended to the end.
+        # firebasehosting.googleapis.com/upload/sites/SITE_ID /versions/VERSION_ID/files"
+        # Perform a multipart `POST` of the Gzipped file contents to the URL using a
+        # forward slash and the hash of the file appended to the end.
         # Corresponds to the JSON property `uploadUrl`
         # @return [String]
         attr_accessor :upload_url
@@ -719,9 +758,7 @@ module Google
         end
       end
       
-      # Version preview configuration. If active and unexpired, this version will be
-      # accessible via a custom URL even if it is not the currently released version.
-      # Deprecated in favor of site channels.
+      # Deprecated in favor of [site channels](sites.channels).
       class PreviewConfig
         include Google::Apis::Core::Hashable
       
@@ -748,14 +785,14 @@ module Google
         end
       end
       
-      # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL
-      # pattern that, if matched to the request URL path, triggers Hosting to respond
-      # with a redirect to the specified destination path.
+      # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects)
+      # specifies a URL pattern that, if matched to the request URL path, triggers
+      # Hosting to respond with a redirect to the specified destination path.
       class Redirect
         include Google::Apis::Core::Hashable
       
-        # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
-        # match against the request URL path.
+        # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#
+        # glob_pattern_matching) to match against the request URL path.
         # Corresponds to the JSON property `glob`
         # @return [String]
         attr_accessor :glob
@@ -804,9 +841,11 @@ module Google
         # @return [String]
         attr_accessor :message
       
-        # Output only. The unique identifier for the release, in the format: sites/ site-
-        # name/releases/releaseID This name is provided in the response body when you
-        # call the [`CreateRelease`](sites.releases/create) endpoint.
+        # Output only. The unique identifier for the release, in either of the following
+        # formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/
+        # CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when
+        # you call [`releases.create`](sites.releases/create) or [`channels.releases.
+        # create`](sites.channels.releases/create).
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -828,8 +867,8 @@ module Google
         # @return [String]
         attr_accessor :type
       
-        # A `Version` is the collection of configuration and [static files](sites.
-        # versions.files) that determine how a site is displayed.
+        # A `Version` is a configuration and a collection of static files which
+        # determine how a site is displayed.
         # Corresponds to the JSON property `version`
         # @return [Google::Apis::FirebasehostingV1beta1::Version]
         attr_accessor :version
@@ -849,9 +888,9 @@ module Google
         end
       end
       
-      # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL
-      # pattern that, if matched to the request URL path, triggers Hosting to respond
-      # as if the service were given the specified destination URL.
+      # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites)
+      # specifies a URL pattern that, if matched to the request URL path, triggers
+      # Hosting to respond as if the service were given the specified destination URL.
       class Rewrite
         include Google::Apis::Core::Hashable
       
@@ -867,8 +906,8 @@ module Google
         # @return [String]
         attr_accessor :function
       
-        # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
-        # match against the request URL path.
+        # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#
+        # glob_pattern_matching) to match against the request URL path.
         # Corresponds to the JSON property `glob`
         # @return [String]
         attr_accessor :glob
@@ -910,8 +949,8 @@ module Google
       # The configuration for how incoming requests to a site should be routed and
       # processed before serving content. The URL request paths are matched against
       # the specified URL patterns in the configuration, then Hosting applies the
-      # applicable configuration according to a specific [priority order](/docs/
-      # hosting/full-config#hosting_priority_order).
+      # applicable configuration according to a specific [priority order](https://
+      # firebase.google.com/docs/hosting/full-config#hosting_priority_order).
       class ServingConfig
         include Google::Apis::Core::Hashable
       
@@ -973,6 +1012,60 @@ module Google
         end
       end
       
+      # A `Site` represents a Firebase Hosting site.
+      class Site
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The [ID of a Web App](https://firebase.google.com/docs/projects/api/
+        # reference/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with
+        # the Hosting site.
+        # Corresponds to the JSON property `appId`
+        # @return [String]
+        attr_accessor :app_id
+      
+        # Output only. The default URL for the Hosting site.
+        # Corresponds to the JSON property `defaultUrl`
+        # @return [String]
+        attr_accessor :default_url
+      
+        # Optional. User-specified labels for the Hosting site.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # Output only. The fully-qualified resource name of the Hosting site, in the
+        # format: projects/PROJECT_IDENTIFIER/sites/SITE_ID PROJECT_IDENTIFIER: the
+        # Firebase project's [`ProjectNumber`](https://firebase.google.com/docs/projects/
+        # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number) ***(
+        # recommended)*** or its [`ProjectId`](https://firebase.google.com/docs/projects/
+        # api/reference/rest/v1beta1/projects#FirebaseProject.FIELDS.project_id). Learn
+        # more about using project identifiers in Google's [AIP 2510 standard](https://
+        # google.aip.dev/cloud/2510).
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # Output only. The type of Hosting site. Every Firebase project has a `
+        # DEFAULT_SITE`, which is created when Hosting is provisioned for the project.
+        # All additional sites are `USER_SITE`.
+        # Corresponds to the JSON property `type`
+        # @return [String]
+        attr_accessor :type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @app_id = args[:app_id] if args.key?(:app_id)
+          @default_url = args[:default_url] if args.key?(:default_url)
+          @labels = args[:labels] if args.key?(:labels)
+          @name = args[:name] if args.key?(:name)
+          @type = args[:type] if args.key?(:type)
+        end
+      end
+      
       # A `SiteConfig` contains metadata associated with a specific site that controls
       # Firebase Hosting serving behavior
       class SiteConfig
@@ -1043,16 +1136,16 @@ module Google
         end
       end
       
-      # A `Version` is the collection of configuration and [static files](sites.
-      # versions.files) that determine how a site is displayed.
+      # A `Version` is a configuration and a collection of static files which
+      # determine how a site is displayed.
       class Version
         include Google::Apis::Core::Hashable
       
         # The configuration for how incoming requests to a site should be routed and
         # processed before serving content. The URL request paths are matched against
         # the specified URL patterns in the configuration, then Hosting applies the
-        # applicable configuration according to a specific [priority order](/docs/
-        # hosting/full-config#hosting_priority_order).
+        # applicable configuration according to a specific [priority order](https://
+        # firebase.google.com/docs/hosting/full-config#hosting_priority_order).
         # Corresponds to the JSON property `config`
         # @return [Google::Apis::FirebasehostingV1beta1::ServingConfig]
         attr_accessor :config
@@ -1101,28 +1194,26 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :labels
       
-        # The unique identifier for a version, in the format: sites/site-name /versions/
-        # versionID This name is provided in the response body when you call the [`
-        # CreateVersion`](../sites.versions/create) endpoint.
+        # The fully-qualified resource name for the version, in the format: sites/
+        # SITE_ID/versions/VERSION_ID This name is provided in the response body when
+        # you call [`CreateVersion`](sites.versions/create).
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
       
-        # Version preview configuration. If active and unexpired, this version will be
-        # accessible via a custom URL even if it is not the currently released version.
-        # Deprecated in favor of site channels.
+        # Deprecated in favor of [site channels](sites.channels).
         # Corresponds to the JSON property `preview`
         # @return [Google::Apis::FirebasehostingV1beta1::PreviewConfig]
         attr_accessor :preview
       
-        # The deploy status of a version. For a successful deploy, call the [`
-        # CreateVersion`](sites.versions/create) endpoint to make a new version (`
-        # CREATED` status), [upload all desired files](sites.versions/populateFiles) to
-        # the version, then [update](sites.versions/patch) the version to the `FINALIZED`
-        # status. Note that if you leave the version in the `CREATED` state for more
-        # than 12 hours, the system will automatically mark the version as `ABANDONED`.
-        # You can also change the status of a version to `DELETED` by calling the [`
-        # DeleteVersion`](sites.versions/delete) endpoint.
+        # The deploy status of the version. For a successful deploy, call [`
+        # CreateVersion`](sites.versions/create) to make a new version (`CREATED` status)
+        # , [upload all desired files](sites.versions/populateFiles) to the version,
+        # then [update](sites.versions/patch) the version to the `FINALIZED` status.
+        # Note that if you leave the version in the `CREATED` state for more than 12
+        # hours, the system will automatically mark the version as `ABANDONED`. You can
+        # also change the status of a version to `DELETED` by calling [`DeleteVersion`](
+        # sites.versions/delete).
         # Corresponds to the JSON property `status`
         # @return [String]
         attr_accessor :status