docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/firebasehosting_v1beta1.sites.releases.html b/docs/dyn/firebasehosting_v1beta1.sites.releases.html
index a07a50e..4891baf 100644
--- a/docs/dyn/firebasehosting_v1beta1.sites.releases.html
+++ b/docs/dyn/firebasehosting_v1beta1.sites.releases.html
@@ -81,7 +81,7 @@
<code><a href="#create">create(parent, body=None, versionName=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the releases that have been created on the specified site.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -102,34 +102,34 @@
The object takes the form of:
{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"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.
+ "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.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "createTime": "A String", # Output only. The time at which the version was created.
+ "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.
+ "createUser": { # 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 version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
- "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.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
- },
- "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- },
- ],
- "appAssociation": "A String", # How to handle well known App Association files.
"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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/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"
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "regex": "A String", # The user-supplied RE2 regular expression 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"
},
],
- "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"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.
@@ -139,43 +139,43 @@
},
},
],
+ "appAssociation": "A String", # How to handle well known App Association files.
"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
+ "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.
+ "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "path": "A String", # The URL path to rewrite the request to.
+ "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.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
+ },
+ "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ },
+ ],
+ },
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "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.
- },
- "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.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
},
- "createUser": { # 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 version.
- "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.
- },
- "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.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "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.
- },
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
},
- "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.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "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.
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
+ "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.
+ "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.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
}
versionName: string, The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.
@@ -188,34 +188,34 @@
An object of the form:
{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"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.
+ "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.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "createTime": "A String", # Output only. The time at which the version was created.
+ "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.
+ "createUser": { # 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 version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
- "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.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
- },
- "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- },
- ],
- "appAssociation": "A String", # How to handle well known App Association files.
"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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/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"
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "regex": "A String", # The user-supplied RE2 regular expression 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"
},
],
- "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"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.
@@ -225,54 +225,54 @@
},
},
],
+ "appAssociation": "A String", # How to handle well known App Association files.
"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
+ "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.
+ "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "path": "A String", # The URL path to rewrite the request to.
+ "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.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
+ },
+ "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ },
+ ],
+ },
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "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.
- },
- "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.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
},
- "createUser": { # 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 version.
- "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.
- },
- "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.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "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.
- },
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
},
- "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.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "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.
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
+ "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.
+ "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.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists the releases that have been created on the specified site.
Args:
parent: string, Required. The parent for which to list files, in the format: sites/site-name (required)
- pageSize: integer, The page size to return. Defaults to 100.
pageToken: string, The next_page_token from a previous request, if provided.
+ pageSize: integer, The page size to return. Defaults to 100.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -284,34 +284,34 @@
{
"releases": [ # The list of hashes of files that still need to be uploaded, if any exist.
{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.
+ "releaseTime": "A String", # Output only. The time at which the version is set to be public.
"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.
+ "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.
+ "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.
- "createTime": "A String", # Output only. The time at which the version was created.
+ "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.
+ "createUser": { # 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 version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
+ "labels": { # The labels used for extra metadata and/or filtering.
+ "a_key": "A String",
+ },
+ "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
- "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.
- "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
- "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.
- "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) 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.
- "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
- "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
- },
- "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
- },
- ],
- "appAssociation": "A String", # How to handle well known App Association files.
"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.
- "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
"glob": "A String", # The user-supplied [glob](/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"
"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.
+ "regex": "A String", # The user-supplied RE2 regular expression 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"
},
],
- "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.
+ "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.
"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.
@@ -321,43 +321,43 @@
},
},
],
+ "appAssociation": "A String", # How to handle well known App Association files.
"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.
"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.
},
+ "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.
+ "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.
+ "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.
+ "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.
+ "path": "A String", # The URL path to rewrite the request to.
+ "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.
+ "serviceId": "A String", # Required. User-defined ID of the Cloud Run service.
+ "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.
+ },
+ "function": "A String", # The function to proxy requests to. Must match the exported function name exactly.
+ },
+ ],
+ },
+ "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
},
"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.
- "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
- "deleteUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `DELETED` the version.
- "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.
- },
- "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.
- "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.
"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.
},
- "createUser": { # 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 version.
- "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.
- },
- "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.
- "finalizeUser": { # Contains metadata about the user who performed an action, such as creating a release or finalizing a version. # Output only. Identifies the user who `FINALIZED` the version.
- "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.
- },
- "labels": { # The labels used for extra metadata and/or filtering.
- "a_key": "A String",
- },
+ "createTime": "A String", # Output only. The time at which the version was created.
+ "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.
},
- "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.
"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.
- "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.
- "releaseTime": "A String", # Output only. The time at which the version is set to be public.
+ "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.
+ "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.
+ "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.
+ "email": "A String", # The email address of the user when the user performed the action.
+ },
},
],
"nextPageToken": "A String", # 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.