| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="firebasehosting_v1beta1.html">Firebase Hosting API</a> . <a href="firebasehosting_v1beta1.sites.html">sites</a> . <a href="firebasehosting_v1beta1.sites.releases.html">releases</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, versionName=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).</p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists the releases that have been created on the specified site.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code class="details" id="create">create(parent, body=None, versionName=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <pre>Creates a new release which makes the content of the specified version actively display on the appropriate URL(s). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | |
| 99 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 100 | parent: string, Required. The site that the release belongs to, in the format: sites/ site-name (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | The object takes the form of: |
| 103 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 104 | { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 105 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 106 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 107 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 108 | "createTime": "A String", # Output only. The time at which the version was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 109 | "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. |
| 110 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 111 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 112 | }, |
| 113 | "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. |
| 114 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 115 | "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. |
| 116 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 117 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 118 | "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. |
| 119 | "email": "A String", # The email address of the user when the user performed the action. |
| 120 | "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. |
| 121 | }, |
| 122 | "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. |
| 123 | "email": "A String", # The email address of the user when the user performed the action. |
| 124 | "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. |
| 125 | }, |
| 126 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| 127 | "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. |
| 128 | "email": "A String", # The email address of the user when the user performed the action. |
| 129 | "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. |
| 130 | }, |
| 131 | "labels": { # The labels used for extra metadata and/or filtering. |
| 132 | "a_key": "A String", |
| 133 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 134 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 135 | "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. |
| 136 | { # 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. |
| 137 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 138 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 139 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| 140 | "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" |
| 141 | }, |
| 142 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 143 | "appAssociation": "A String", # How to handle well known App Association files. |
| 144 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 145 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 146 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| 147 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 148 | "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. |
| 149 | { # 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. |
| 150 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 151 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 152 | "path": "A String", # The URL path to rewrite the request to. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 153 | "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. |
| 154 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 155 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 156 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 157 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 158 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 159 | }, |
| 160 | ], |
| 161 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 162 | "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. |
| 163 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 164 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 165 | "headers": { # Required. The additional headers to add to the response. |
| 166 | "a_key": "A String", |
| 167 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 168 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 169 | }, |
| 170 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 171 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 172 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 173 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 174 | "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. |
| 175 | "email": "A String", # The email address of the user when the user performed the action. |
| 176 | "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. |
| 177 | }, |
| 178 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 179 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 180 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 181 | 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`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 182 | x__xgafv: string, V1 error format. |
| 183 | Allowed values |
| 184 | 1 - v1 error format |
| 185 | 2 - v2 error format |
| 186 | |
| 187 | Returns: |
| 188 | An object of the form: |
| 189 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 190 | { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 191 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 192 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 193 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 194 | "createTime": "A String", # Output only. The time at which the version was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 195 | "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. |
| 196 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 197 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 198 | }, |
| 199 | "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. |
| 200 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 201 | "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. |
| 202 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 203 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 204 | "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. |
| 205 | "email": "A String", # The email address of the user when the user performed the action. |
| 206 | "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. |
| 207 | }, |
| 208 | "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. |
| 209 | "email": "A String", # The email address of the user when the user performed the action. |
| 210 | "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. |
| 211 | }, |
| 212 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| 213 | "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. |
| 214 | "email": "A String", # The email address of the user when the user performed the action. |
| 215 | "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. |
| 216 | }, |
| 217 | "labels": { # The labels used for extra metadata and/or filtering. |
| 218 | "a_key": "A String", |
| 219 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 220 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 221 | "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. |
| 222 | { # 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. |
| 223 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 224 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 225 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| 226 | "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" |
| 227 | }, |
| 228 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 229 | "appAssociation": "A String", # How to handle well known App Association files. |
| 230 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 231 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 232 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| 233 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 234 | "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. |
| 235 | { # 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. |
| 236 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 237 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 238 | "path": "A String", # The URL path to rewrite the request to. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 239 | "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. |
| 240 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 241 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 242 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 243 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 244 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 245 | }, |
| 246 | ], |
| 247 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 248 | "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. |
| 249 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 250 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 251 | "headers": { # Required. The additional headers to add to the response. |
| 252 | "a_key": "A String", |
| 253 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 254 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 255 | }, |
| 256 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 257 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 258 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 259 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 260 | "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. |
| 261 | "email": "A String", # The email address of the user when the user performed the action. |
| 262 | "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. |
| 263 | }, |
| 264 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 265 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 266 | </div> |
| 267 | |
| 268 | <div class="method"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 269 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 270 | <pre>Lists the releases that have been created on the specified site. |
| 271 | |
| 272 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 273 | parent: string, Required. The parent for which to list files, in the format: sites/site-name (required) |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 274 | pageSize: integer, The page size to return. Defaults to 100. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 275 | pageToken: string, The next_page_token from a previous request, if provided. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | x__xgafv: string, V1 error format. |
| 277 | Allowed values |
| 278 | 1 - v1 error format |
| 279 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | |
| 281 | Returns: |
| 282 | An object of the form: |
| 283 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 284 | { |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 285 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 286 | "releases": [ # The list of hashes of files that still need to be uploaded, if any exist. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 287 | { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 288 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 289 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 290 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 291 | "createTime": "A String", # Output only. The time at which the version was created. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 292 | "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. |
| 293 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 294 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 295 | }, |
| 296 | "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. |
| 297 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 298 | "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. |
| 299 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 300 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 301 | "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. |
| 302 | "email": "A String", # The email address of the user when the user performed the action. |
| 303 | "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. |
| 304 | }, |
| 305 | "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. |
| 306 | "email": "A String", # The email address of the user when the user performed the action. |
| 307 | "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. |
| 308 | }, |
| 309 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| 310 | "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. |
| 311 | "email": "A String", # The email address of the user when the user performed the action. |
| 312 | "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. |
| 313 | }, |
| 314 | "labels": { # The labels used for extra metadata and/or filtering. |
| 315 | "a_key": "A String", |
| 316 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 317 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 318 | "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. |
| 319 | { # 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. |
| 320 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 321 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 322 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| 323 | "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" |
| 324 | }, |
| 325 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 326 | "appAssociation": "A String", # How to handle well known App Association files. |
| 327 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 328 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 329 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| 330 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 331 | "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. |
| 332 | { # 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. |
| 333 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 334 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 335 | "path": "A String", # The URL path to rewrite the request to. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 336 | "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. |
| 337 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 338 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 339 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 340 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 341 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 342 | }, |
| 343 | ], |
| 344 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 345 | "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. |
| 346 | { # 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 347 | "glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 348 | "headers": { # Required. The additional headers to add to the response. |
| 349 | "a_key": "A String", |
| 350 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 351 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 352 | }, |
| 353 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 354 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 355 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 356 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 357 | "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. |
| 358 | "email": "A String", # The email address of the user when the user performed the action. |
| 359 | "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. |
| 360 | }, |
| 361 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 362 | }, |
| 363 | ], |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 364 | }</pre> |
| 365 | </div> |
| 366 | |
| 367 | <div class="method"> |
| 368 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 369 | <pre>Retrieves the next page of results. |
| 370 | |
| 371 | Args: |
| 372 | previous_request: The request for the previous page. (required) |
| 373 | previous_response: The response from the request for the previous page. (required) |
| 374 | |
| 375 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 377 | page. Returns None if there are no more items in the collection. |
| 378 | </pre> |
| 379 | </div> |
| 380 | |
| 381 | </body></html> |