| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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.projects.html">projects</a> . <a href="firebasehosting_v1beta1.projects.sites.html">sites</a> . <a href="firebasehosting_v1beta1.projects.sites.channels.html">channels</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="firebasehosting_v1beta1.projects.sites.channels.releases.html">releases()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the releases Resource.</p> |
| 81 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="toc_element"> |
| 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#create">create(parent, body=None, channelId=None, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Creates a new channel in the specified site.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Deletes a channel of a site. The `live` channel cannot be deleted.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 93 | <p class="firstline">Retrieves information for the specified channel of a site.</p> |
| 94 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 95 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 96 | <p class="firstline">Lists the channels for the specified site. All sites have a default "live" channel.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 99 | <p class="firstline">Retrieves the next page of results.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist.</p> |
| 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| 105 | <code class="details" id="close">close()</code> |
| 106 | <pre>Close httplib2 connections.</pre> |
| 107 | </div> |
| 108 | |
| 109 | <div class="method"> |
| 110 | <code class="details" id="create">create(parent, body=None, channelId=None, x__xgafv=None)</code> |
| 111 | <pre>Creates a new channel in the specified site. |
| 112 | |
| 113 | Args: |
| 114 | parent: string, Required. The site in which this channel should be created. (required) |
| 115 | body: object, The request body. |
| 116 | The object takes the form of: |
| 117 | |
| 118 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 119 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 120 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 121 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 122 | "a_key": "A String", |
| 123 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 124 | "name": "A String", # The fully-qualified identifier of the Channel. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 125 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 126 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 127 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 128 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 129 | "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. |
| 130 | "email": "A String", # The email address of the user when the user performed the action. |
| 131 | "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. |
| 132 | }, |
| 133 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 134 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 135 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 136 | "appAssociation": "A String", # How to handle well known App Association files. |
| 137 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 138 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 139 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 140 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 141 | "headers": { # Required. The additional headers to add to the response. |
| 142 | "a_key": "A String", |
| 143 | }, |
| 144 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 145 | }, |
| 146 | ], |
| 147 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 148 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| 149 | }, |
| 150 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 151 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 152 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 153 | "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" |
| 154 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 155 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 156 | }, |
| 157 | ], |
| 158 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 159 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 160 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 161 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 162 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 163 | "path": "A String", # The URL path to rewrite the request to. |
| 164 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 165 | "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. |
| 166 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 167 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 168 | }, |
| 169 | }, |
| 170 | ], |
| 171 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| 172 | }, |
| 173 | "createTime": "A String", # Output only. The time at which the version was created. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 174 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 175 | "email": "A String", # The email address of the user when the user performed the action. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 177 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 178 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 179 | "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. |
| 180 | "email": "A String", # The email address of the user when the user performed the action. |
| 181 | "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. |
| 182 | }, |
| 183 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 184 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 185 | "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. |
| 186 | "email": "A String", # The email address of the user when the user performed the action. |
| 187 | "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. |
| 188 | }, |
| 189 | "labels": { # The labels used for extra metadata and/or filtering. |
| 190 | "a_key": "A String", |
| 191 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 192 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 193 | "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. |
| 194 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 195 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 196 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 197 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 198 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 199 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 200 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 201 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 202 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 203 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 204 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 205 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 206 | |
| 207 | channelId: string, Required. Immutable. A unique id within the site to identify the channel. |
| 208 | x__xgafv: string, V1 error format. |
| 209 | Allowed values |
| 210 | 1 - v1 error format |
| 211 | 2 - v2 error format |
| 212 | |
| 213 | Returns: |
| 214 | An object of the form: |
| 215 | |
| 216 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 217 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 218 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| 219 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 220 | "a_key": "A String", |
| 221 | }, |
| 222 | "name": "A String", # The fully-qualified identifier of the Channel. |
| 223 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 224 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 225 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 226 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 227 | "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. |
| 228 | "email": "A String", # The email address of the user when the user performed the action. |
| 229 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 230 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 231 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 232 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 233 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | "appAssociation": "A String", # How to handle well known App Association files. |
| 235 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 236 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 237 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 238 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 239 | "headers": { # Required. The additional headers to add to the response. |
| 240 | "a_key": "A String", |
| 241 | }, |
| 242 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 243 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 244 | ], |
| 245 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 246 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 247 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 248 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 249 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 250 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 251 | "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" |
| 252 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 253 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 254 | }, |
| 255 | ], |
| 256 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 257 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 258 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 259 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 260 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 261 | "path": "A String", # The URL path to rewrite the request to. |
| 262 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 263 | "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. |
| 264 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 265 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 266 | }, |
| 267 | }, |
| 268 | ], |
| 269 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 270 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 271 | "createTime": "A String", # Output only. The time at which the version was created. |
| 272 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 273 | "email": "A String", # The email address of the user when the user performed the action. |
| 274 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 275 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 276 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 277 | "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. |
| 278 | "email": "A String", # The email address of the user when the user performed the action. |
| 279 | "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. |
| 280 | }, |
| 281 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 282 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 283 | "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. |
| 284 | "email": "A String", # The email address of the user when the user performed the action. |
| 285 | "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. |
| 286 | }, |
| 287 | "labels": { # The labels used for extra metadata and/or filtering. |
| 288 | "a_key": "A String", |
| 289 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 290 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 291 | "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. |
| 292 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 293 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 294 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 295 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 296 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 297 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 298 | }, |
| 299 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 300 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 301 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 302 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| 303 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 304 | </div> |
| 305 | |
| 306 | <div class="method"> |
| 307 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 308 | <pre>Deletes a channel of a site. The `live` channel cannot be deleted. |
| 309 | |
| 310 | Args: |
| 311 | name: string, Required. The fully-qualified identifier for the site. (required) |
| 312 | x__xgafv: string, V1 error format. |
| 313 | Allowed values |
| 314 | 1 - v1 error format |
| 315 | 2 - v2 error format |
| 316 | |
| 317 | Returns: |
| 318 | An object of the form: |
| 319 | |
| 320 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 321 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 322 | </div> |
| 323 | |
| 324 | <div class="method"> |
| 325 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 326 | <pre>Retrieves information for the specified channel of a site. |
| 327 | |
| 328 | Args: |
| 329 | name: string, Required. The fully-qualified identifier for the channel. (required) |
| 330 | x__xgafv: string, V1 error format. |
| 331 | Allowed values |
| 332 | 1 - v1 error format |
| 333 | 2 - v2 error format |
| 334 | |
| 335 | Returns: |
| 336 | An object of the form: |
| 337 | |
| 338 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 339 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 340 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| 341 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 342 | "a_key": "A String", |
| 343 | }, |
| 344 | "name": "A String", # The fully-qualified identifier of the Channel. |
| 345 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 346 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 347 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 348 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 349 | "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. |
| 350 | "email": "A String", # The email address of the user when the user performed the action. |
| 351 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 352 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 353 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 354 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 355 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 356 | "appAssociation": "A String", # How to handle well known App Association files. |
| 357 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 358 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 359 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 360 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 361 | "headers": { # Required. The additional headers to add to the response. |
| 362 | "a_key": "A String", |
| 363 | }, |
| 364 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 365 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 366 | ], |
| 367 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 368 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 369 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 370 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 371 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 372 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 373 | "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" |
| 374 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 375 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 376 | }, |
| 377 | ], |
| 378 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 379 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 380 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 381 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 382 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 383 | "path": "A String", # The URL path to rewrite the request to. |
| 384 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 385 | "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. |
| 386 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 387 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 388 | }, |
| 389 | }, |
| 390 | ], |
| 391 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 392 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 393 | "createTime": "A String", # Output only. The time at which the version was created. |
| 394 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 395 | "email": "A String", # The email address of the user when the user performed the action. |
| 396 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 397 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 398 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 399 | "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. |
| 400 | "email": "A String", # The email address of the user when the user performed the action. |
| 401 | "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. |
| 402 | }, |
| 403 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 404 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 405 | "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. |
| 406 | "email": "A String", # The email address of the user when the user performed the action. |
| 407 | "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. |
| 408 | }, |
| 409 | "labels": { # The labels used for extra metadata and/or filtering. |
| 410 | "a_key": "A String", |
| 411 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 412 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 413 | "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. |
| 414 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 415 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 416 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 417 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 418 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 419 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 420 | }, |
| 421 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 422 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 423 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 424 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| 425 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 426 | </div> |
| 427 | |
| 428 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 429 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 430 | <pre>Lists the channels for the specified site. All sites have a default "live" channel. |
| 431 | |
| 432 | Args: |
| 433 | parent: string, Required. The site from which to list channels. (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 434 | pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 channels will be returned. The maximum value is 100; valuupdateses above 100 will be coerced to 100 |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 435 | pageToken: string, The next_page_token from a previous request, if provided. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 436 | x__xgafv: string, V1 error format. |
| 437 | Allowed values |
| 438 | 1 - v1 error format |
| 439 | 2 - v2 error format |
| 440 | |
| 441 | Returns: |
| 442 | An object of the form: |
| 443 | |
| 444 | { # The response returned by ListChannels. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 445 | "channels": [ # The list of channels. |
| 446 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| 447 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 448 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| 449 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 450 | "a_key": "A String", |
| 451 | }, |
| 452 | "name": "A String", # The fully-qualified identifier of the Channel. |
| 453 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 454 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 455 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 456 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 457 | "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. |
| 458 | "email": "A String", # The email address of the user when the user performed the action. |
| 459 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 460 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 461 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 462 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 463 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 464 | "appAssociation": "A String", # How to handle well known App Association files. |
| 465 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 466 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 467 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 468 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 469 | "headers": { # Required. The additional headers to add to the response. |
| 470 | "a_key": "A String", |
| 471 | }, |
| 472 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 473 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 474 | ], |
| 475 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 476 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 477 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 478 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 479 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 480 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 481 | "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" |
| 482 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 483 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 484 | }, |
| 485 | ], |
| 486 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 487 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 488 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 489 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 490 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 491 | "path": "A String", # The URL path to rewrite the request to. |
| 492 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 493 | "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. |
| 494 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 495 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 496 | }, |
| 497 | }, |
| 498 | ], |
| 499 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 500 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 501 | "createTime": "A String", # Output only. The time at which the version was created. |
| 502 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 503 | "email": "A String", # The email address of the user when the user performed the action. |
| 504 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 505 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 506 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 507 | "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. |
| 508 | "email": "A String", # The email address of the user when the user performed the action. |
| 509 | "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. |
| 510 | }, |
| 511 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 512 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 513 | "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. |
| 514 | "email": "A String", # The email address of the user when the user performed the action. |
| 515 | "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. |
| 516 | }, |
| 517 | "labels": { # The labels used for extra metadata and/or filtering. |
| 518 | "a_key": "A String", |
| 519 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 520 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 521 | "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. |
| 522 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 523 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 524 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 525 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 526 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 527 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 528 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 529 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 530 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 531 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 532 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| 533 | }, |
| 534 | ], |
| 535 | "nextPageToken": "A String", # If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.channels/list) call to continue with the next set of releases. |
| 536 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 537 | </div> |
| 538 | |
| 539 | <div class="method"> |
| 540 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 541 | <pre>Retrieves the next page of results. |
| 542 | |
| 543 | Args: |
| 544 | previous_request: The request for the previous page. (required) |
| 545 | previous_response: The response from the request for the previous page. (required) |
| 546 | |
| 547 | Returns: |
| 548 | A request object that you can call 'execute()' on to request the next |
| 549 | page. Returns None if there are no more items in the collection. |
| 550 | </pre> |
| 551 | </div> |
| 552 | |
| 553 | <div class="method"> |
| 554 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 555 | <pre>Updates information for the specified channel of a site. This method will implicitly create a channel if it doesn't exist. |
| 556 | |
| 557 | Args: |
| 558 | name: string, The fully-qualified identifier of the Channel. (required) |
| 559 | body: object, The request body. |
| 560 | The object takes the form of: |
| 561 | |
| 562 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 563 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 564 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 565 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 566 | "a_key": "A String", |
| 567 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 568 | "name": "A String", # The fully-qualified identifier of the Channel. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 569 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 570 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 571 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 572 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 573 | "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. |
| 574 | "email": "A String", # The email address of the user when the user performed the action. |
| 575 | "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. |
| 576 | }, |
| 577 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 578 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 579 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 580 | "appAssociation": "A String", # How to handle well known App Association files. |
| 581 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 582 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 583 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 584 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 585 | "headers": { # Required. The additional headers to add to the response. |
| 586 | "a_key": "A String", |
| 587 | }, |
| 588 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 589 | }, |
| 590 | ], |
| 591 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 592 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| 593 | }, |
| 594 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 595 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 596 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 597 | "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" |
| 598 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 599 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 600 | }, |
| 601 | ], |
| 602 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 603 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 604 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 605 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 606 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 607 | "path": "A String", # The URL path to rewrite the request to. |
| 608 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 609 | "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. |
| 610 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 611 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 612 | }, |
| 613 | }, |
| 614 | ], |
| 615 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| 616 | }, |
| 617 | "createTime": "A String", # Output only. The time at which the version was created. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 618 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 619 | "email": "A String", # The email address of the user when the user performed the action. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 620 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 621 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 622 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 623 | "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. |
| 624 | "email": "A String", # The email address of the user when the user performed the action. |
| 625 | "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. |
| 626 | }, |
| 627 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 628 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 629 | "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. |
| 630 | "email": "A String", # The email address of the user when the user performed the action. |
| 631 | "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. |
| 632 | }, |
| 633 | "labels": { # The labels used for extra metadata and/or filtering. |
| 634 | "a_key": "A String", |
| 635 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 636 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 637 | "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. |
| 638 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 639 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 640 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 641 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 642 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 643 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 644 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 645 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 646 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 647 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 648 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 649 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 650 | |
| 651 | updateMask: string, A comma-separated list of fields to be updated in this request. |
| 652 | x__xgafv: string, V1 error format. |
| 653 | Allowed values |
| 654 | 1 - v1 error format |
| 655 | 2 - v2 error format |
| 656 | |
| 657 | Returns: |
| 658 | An object of the form: |
| 659 | |
| 660 | { # A `Channel` represents a stream of releases for a site. All sites have a default `live` channel that serves content to the live Firebase-provided domains and any connected custom domains. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 661 | "createTime": "A String", # Output only. The time at which the channel was created. |
| 662 | "expireTime": "A String", # The time at which the channel will be automatically deleted. If null, the channel will not be automatically deleted. This field is present in output whether set directly or via the `ttl` field. |
| 663 | "labels": { # Text labels used for extra metadata and/or filtering. |
| 664 | "a_key": "A String", |
| 665 | }, |
| 666 | "name": "A String", # The fully-qualified identifier of the Channel. |
| 667 | "release": { # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time. # Output only. The current release for the channel, if any. |
| 668 | "message": "A String", # The deploy description when the release was created. The value can be up to 512 characters. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 669 | "name": "A String", # Output only. The unique identifier for the release, in the format: sites/ SITE_NAME/releases/RELEASE_ID This name is provided in the response body when you call [`CreateRelease`](sites.releases/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 670 | "releaseTime": "A String", # Output only. The time at which the version is set to be public. |
| 671 | "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. |
| 672 | "email": "A String", # The email address of the user when the user performed the action. |
| 673 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 674 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 675 | "type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 676 | "version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released. |
| 677 | "config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 678 | "appAssociation": "A String", # How to handle well known App Association files. |
| 679 | "cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files. |
| 680 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 681 | { # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers. |
| 682 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 683 | "headers": { # Required. The additional headers to add to the response. |
| 684 | "a_key": "A String", |
| 685 | }, |
| 686 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 687 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 688 | ], |
| 689 | "i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior. |
| 690 | "root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 691 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 692 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 693 | { # A [`Redirect`](https://firebase.google.com/docs/hosting/full-config#redirects) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path. |
| 694 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 695 | "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" |
| 696 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 697 | "statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code. |
| 698 | }, |
| 699 | ], |
| 700 | "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. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 701 | { # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 702 | "dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links. |
| 703 | "function": "A String", # The function to proxy requests to. Must match the exported function name exactly. |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 704 | "glob": "A String", # The user-supplied [glob](https://firebase.google.com/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 705 | "path": "A String", # The URL path to rewrite the request to. |
| 706 | "regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path. |
| 707 | "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. |
| 708 | "region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied. |
| 709 | "serviceId": "A String", # Required. User-defined ID of the Cloud Run service. |
| 710 | }, |
| 711 | }, |
| 712 | ], |
| 713 | "trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 714 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 715 | "createTime": "A String", # Output only. The time at which the version was created. |
| 716 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 717 | "email": "A String", # The email address of the user when the user performed the action. |
| 718 | "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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 719 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 720 | "deleteTime": "A String", # Output only. The time at which the version was `DELETED`. |
| 721 | "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. |
| 722 | "email": "A String", # The email address of the user when the user performed the action. |
| 723 | "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. |
| 724 | }, |
| 725 | "fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`. |
| 726 | "finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`. |
| 727 | "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. |
| 728 | "email": "A String", # The email address of the user when the user performed the action. |
| 729 | "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. |
| 730 | }, |
| 731 | "labels": { # The labels used for extra metadata and/or filtering. |
| 732 | "a_key": "A String", |
| 733 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 734 | "name": "A String", # The unique identifier for a version, in the format: sites/SITE_NAME /versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 735 | "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. |
| 736 | "active": True or False, # If true, preview URLs are enabled for this version. |
| 737 | "expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404. |
| 738 | }, |
| yoshi-code-bot | 6970659 | 2021-03-03 03:54:02 -0800 | [diff] [blame^] | 739 | "status": "A String", # The deploy status of a version. For a successful deploy, call [`CreateVersion`](sites.versions/create) to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling [`DeleteVersion`](sites.versions/delete). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 740 | "versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 741 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 742 | }, |
| 743 | "retainedReleaseCount": 42, # The number of previous releases to retain on the channel for rollback or other purposes. Must be a number between 1-100. Defaults to 10 for new channels. |
| 744 | "ttl": "A String", # Input only. A time-to-live for this channel. Sets `expire_time` to the provided duration past the time of the request. |
| 745 | "updateTime": "A String", # Output only. The time at which the channel was last updated. |
| 746 | "url": "A String", # Output only. The URL at which the channel can be viewed. For the `live` channel, the content of the current release may also be visible at other URLs. |
| 747 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 748 | </div> |
| 749 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 750 | </body></html> |