chore: Update discovery artifacts (#1208)
## Discovery Artifact Change Summary:
admindirectory_v1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/3fc3b7614d5df2917e6285a1d4834cbcffd7c665)
adminreports_v1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/3fc3b7614d5df2917e6285a1d4834cbcffd7c665)
admobv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a2400d9c226a479be6532e1e2822efecc72b87c5)
admobv1beta[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a2400d9c226a479be6532e1e2822efecc72b87c5)
analyticsv3[ [More details]](https://github.com/googleapis/google-api-python-client/commit/61136a15f60ec8deedca3f31a575865c3a28e49b)
analyticsreportingv4[ [More details]](https://github.com/googleapis/google-api-python-client/commit/03ee301449791d11cb7653d9a6431418304e5fbe)
androidenterprisev1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/09a9ddc212d0062fcac494136a4fc21015cfa527)
assuredworkloadsv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a7b9f4cadc1168ec764f0839027d17a9a474a9ed)
bigquerydatatransferv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/52de288372258c6c926f646e8b77ced31245f705)
classroomv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/ec6203468fc483eec6a65c9464443f2d1a0b79c0)
cloudassetv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
cloudassetv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
cloudassetv1p1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
cloudassetv1p4beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
cloudassetv1p5beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
cloudassetv1p7beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/0e739c196ee75a225348798e2eb29b1ba599841a)
clouderrorreportingv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/aee2d1da567892798889b6231852bfb48a749de1)
cloudiotv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/c1635fdcd108c85ca6be0901ecb9f7f7468b7e3d)
cloudsearchv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/3ee9ab15d37a6c933d8b48eda9fec8125309040a)
cloudshellv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/e10759569feb88aa1a02472719a21f7beaa8a349)
containerv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/47958636b0fa68d9c23bacd765b90954293c7551)
datalabelingv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/ad487d5fd8455823ed044dd6567d1e1a85729755)
dfareportingv3.3[ [More details]](https://github.com/googleapis/google-api-python-client/commit/fc38ed0d8aabe80a003866059d59f03b67c9de9f)
dfareportingv3.4[ [More details]](https://github.com/googleapis/google-api-python-client/commit/fc38ed0d8aabe80a003866059d59f03b67c9de9f)
docsv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/c6dcde43ee5c4bf53fcbbdbc52a88b73b9c45e2d)
domainsv1alpha2[ [More details]](https://github.com/googleapis/google-api-python-client/commit/92b5958ee1e954019be6582e7ce80703ff91f17d)
domainsv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/92b5958ee1e954019be6582e7ce80703ff91f17d)
doubleclickbidmanagerv1.1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/2cf24fd0a733a07b55ad481165e9635b4e7bf9a3)
drivev2[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a060399fea6a34ed6982db0186345eac27eedadd)
drivev3[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a060399fea6a34ed6982db0186345eac27eedadd)
fcmv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/348a8bc10b44abe8e994b1619bee5e2333074411)
firebasehostingv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/15eb02bb44876ab6873539c206c064bd08e6684c)
fitnessv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/b40a9bb9c0f0c18c4839f58ecbe5f85c84053259)
gmailv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/6a77c586893584132d964293e1be34356d5fbfcb)
groupssettingsv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/bbbcfde0767f9dff176b9dce7432b4d7f2bc739e)
homegraphv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a867202c70cd9e7ee711ae13e43b8c5ce3f4cdbf)
indexnan[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a867202c70cd9e7ee711ae13e43b8c5ce3f4cdbf)
loggingv2[ [More details]](https://github.com/googleapis/google-api-python-client/commit/8fcbde03c7790ced3dbcba11e05bea7a8f451ac4)
peoplev1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/6e4c87a393b295e72ec11a5b1e752e2c139685df)
recommendationenginev1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/e6ace9e4dfbe429016788fd3a4a32de8f359a2d1)
recommenderv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/c340d3f0d43cb250159fda91a0f884c06aa19346)
recommenderv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/c340d3f0d43cb250159fda91a0f884c06aa19346)
redisv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/f0d31fe127c3bcac9285457ff6510a6d9b4d7025)
redisv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/f0d31fe127c3bcac9285457ff6510a6d9b4d7025)
scriptv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/d235c949a32d1ce099cc6f1f161dc4930949bd80)
servicedirectoryv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/b8e06d2e15229e868b698cb4a296f3202f84bf24)
servicemanagementv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/eb37d585a103ca332e3af48a0f46c1408e805863)
smartdevicemanagementv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/67bfa0e50eb1a761222f3d424e662043b0a29171)
streetviewpublishv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/5825e78ab4c5b3a0bbfc85fa332e4962096fdb55)
tasksv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/dcd228af6573a3163da3cfaca9c0cb6cd679d282)
texttospeechv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/43220b5cd401440812e76821e6cbd5c3099659cd)
texttospeechv1beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/43220b5cd401440812e76821e6cbd5c3099659cd)
trafficdirectorv2[ [More details]](https://github.com/googleapis/google-api-python-client/commit/4141254d0c9f8627a35a5be19f23f673fc619164)
translatev3[ [More details]](https://github.com/googleapis/google-api-python-client/commit/b0bec6c2662ed00b6e80c5fd361fadf396f4e00c)
translatev3beta1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/b0bec6c2662ed00b6e80c5fd361fadf396f4e00c)
vaultv1[ [More details]](https://github.com/googleapis/google-api-python-client/commit/f946ac2b3cfa3f8566ceea85110b919a7d974352)
workflowsv1beta[ [More details]](https://github.com/googleapis/google-api-python-client/commit/a4ff4fcf07923786768354ab7f5cdef28ba3e29f)
diff --git a/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html b/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
index 8d43161..9079a8c 100644
--- a/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
+++ b/docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html
@@ -124,20 +124,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -148,18 +148,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -189,12 +189,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
@@ -222,20 +222,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -246,18 +246,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -287,12 +287,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
@@ -344,20 +344,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -368,18 +368,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -409,12 +409,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
@@ -452,20 +452,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -476,18 +476,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -517,12 +517,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
@@ -568,20 +568,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -592,18 +592,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -633,12 +633,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},
@@ -666,20 +666,20 @@
"name": "A String", # The fully-qualified identifier of the Channel.
"release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "name": "A String", # 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.
+ "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create).
"releaseTime": "A String", # Output only. The time at which the version is set to be public.
"releaseUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who created the release.
"email": "A String", # The email address of the user when the user performed the action.
"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.
},
"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.
- "version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.
- "config": { # 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). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.
+ "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.
+ "config": { # 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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.
"appAssociation": "A String", # How to handle well known App Association files.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
- { # 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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ { # 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"headers": { # Required. The additional headers to add to the response.
"a_key": "A String",
},
@@ -690,18 +690,18 @@
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
"redirects": [ # An array of objects (called redirect rules), where each rule 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`](/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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL 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.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
},
],
"rewrites": [ # An array of objects (called rewrite rules), where each rule 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`](/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.
"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
"path": "A String", # The URL path to rewrite the request to.
"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.
@@ -731,12 +731,12 @@
"labels": { # The labels used for extra metadata and/or filtering.
"a_key": "A String",
},
- "name": "A String", # 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.
+ "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).
"preview": { # 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. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.
"active": True or False, # If true, preview URLs are enabled for this version.
"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.
},
- "status": "A String", # 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.
+ "status": "A String", # The deploy status of a 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).
"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
},
},