Blame - docs/dyn/firebasehosting_v1beta1.projects.sites.channels.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

82

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

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

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

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

Yoshi Automation Bot

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

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

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

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

105

<code class="details" id="close">close()</code>

106

<pre>Close httplib2 connections.</pre>

</div>

<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

2020-12-09 08:56:03 -0800

[diff] [blame^]

119

"updateTime": "A String", # Output only. The time at which the channel was last updated.

120

"labels": { # Text labels used for extra metadata and/or filtering.

121

"a_key": "A String",

122

},

123

"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.

124

"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.

125

"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.

126

"name": "A String", # The fully-qualified identifier of the Channel.

127

"createTime": "A String", # Output only. The time at which the channel was created.

128

"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.

129

"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.

130

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

131

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

132

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

133

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

134

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

135

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

136

"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.

137

"active": True or False, # If true, preview URLs are enabled for this version.

138

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

139

},

140

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

141

"labels": { # The labels used for extra metadata and/or filtering.

142

"a_key": "A String",

143

},

144

"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.

145

"email": "A String", # The email address of the user when the user performed the action.

146

"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.

147

},

148

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

149

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

150

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

151

"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.

152

"email": "A String", # The email address of the user when the user performed the action.

153

"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.

154

},

155

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

156

"createTime": "A String", # Output only. The time at which the version was created.

157

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

158

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

159

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

160

},

161

"appAssociation": "A String", # How to handle well known App Association files.

162

"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.

163

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

164

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

165

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

166

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

167

"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"

168

},

169

],

170

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

171

"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.

172

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

173

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

174

"headers": { # Required. The additional headers to add to the response.

175

"a_key": "A String",

176

},

177

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

178

},

179

],

180

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

181

"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.

182

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

183

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

184

"path": "A String", # The URL path to rewrite the request to.

185

"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.

186

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

187

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

188

},

189

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

190

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

191

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

196

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

197

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

198

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

199

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

200

"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.

201

"email": "A String", # The email address of the user when the user performed the action.

202

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

203

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

204

},

205

}

Dmitry Frenkel

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-12-09 08:56:03 -0800

[diff] [blame^]

217

"updateTime": "A String", # Output only. The time at which the channel was last updated.

218

"labels": { # Text labels used for extra metadata and/or filtering.

219

"a_key": "A String",

220

},

221

"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.

222

"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.

223

"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.

224

"name": "A String", # The fully-qualified identifier of the Channel.

225

"createTime": "A String", # Output only. The time at which the channel was created.

226

"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.

227

"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.

228

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

229

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

230

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

231

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

232

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

233

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

234

"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.

235

"active": True or False, # If true, preview URLs are enabled for this version.

236

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

237

},

238

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

239

"labels": { # The labels used for extra metadata and/or filtering.

240

"a_key": "A String",

241

},

242

"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.

243

"email": "A String", # The email address of the user when the user performed the action.

244

"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.

245

},

246

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

247

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

248

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

249

"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.

250

"email": "A String", # The email address of the user when the user performed the action.

251

"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.

252

},

253

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

254

"createTime": "A String", # Output only. The time at which the version was created.

255

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

256

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

257

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

258

},

259

"appAssociation": "A String", # How to handle well known App Association files.

260

"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.

261

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

262

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

263

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

264

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

265

"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"

266

},

267

],

268

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

269

"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.

270

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

271

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

272

"headers": { # Required. The additional headers to add to the response.

273

"a_key": "A String",

274

},

275

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

276

},

277

],

278

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

279

"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.

280

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

281

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

282

"path": "A String", # The URL path to rewrite the request to.

283

"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.

284

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

285

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

286

},

287

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

288

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

289

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

294

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

295

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

296

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

297

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

298

"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.

299

"email": "A String", # The email address of the user when the user performed the action.

300

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

301

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

302

},

303

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-12-09 08:56:03 -0800

[diff] [blame^]

339

"updateTime": "A String", # Output only. The time at which the channel was last updated.

340

"labels": { # Text labels used for extra metadata and/or filtering.

341

"a_key": "A String",

342

},

343

"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.

344

"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.

345

"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.

346

"name": "A String", # The fully-qualified identifier of the Channel.

347

"createTime": "A String", # Output only. The time at which the channel was created.

348

"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.

349

"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.

350

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

351

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

352

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

353

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

354

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

355

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

356

"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.

357

"active": True or False, # If true, preview URLs are enabled for this version.

358

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

359

},

360

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

361

"labels": { # The labels used for extra metadata and/or filtering.

362

"a_key": "A String",

363

},

364

"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.

365

"email": "A String", # The email address of the user when the user performed the action.

366

"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.

367

},

368

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

369

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

370

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

371

"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.

372

"email": "A String", # The email address of the user when the user performed the action.

373

"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.

374

},

375

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

376

"createTime": "A String", # Output only. The time at which the version was created.

377

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

378

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

379

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

380

},

381

"appAssociation": "A String", # How to handle well known App Association files.

382

"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.

383

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

384

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

385

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

386

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

387

"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"

388

},

389

],

390

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

391

"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.

392

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

393

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

394

"headers": { # Required. The additional headers to add to the response.

395

"a_key": "A String",

396

},

397

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

398

},

399

],

400

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

401

"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.

402

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

403

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

404

"path": "A String", # The URL path to rewrite the request to.

405

"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.

406

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

407

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

408

},

409

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

410

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

411

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

416

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

417

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

418

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

419

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

420

"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.

421

"email": "A String", # The email address of the user when the user performed the action.

422

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

423

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

424

},

425

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

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

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

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

2020-12-09 08:56:03 -0800

[diff] [blame^]

435

pageToken: string, The next_page_token from a previous request, if provided.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

436

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

443

444

{ # The response returned by ListChannels.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[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.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

447

"updateTime": "A String", # Output only. The time at which the channel was last updated.

448

"labels": { # Text labels used for extra metadata and/or filtering.

449

"a_key": "A String",

450

},

451

"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.

452

"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.

453

"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.

454

"name": "A String", # The fully-qualified identifier of the Channel.

455

"createTime": "A String", # Output only. The time at which the channel was created.

456

"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.

457

"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.

458

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

459

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

460

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

461

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

462

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

463

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

464

"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.

465

"active": True or False, # If true, preview URLs are enabled for this version.

466

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

467

},

468

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

469

"labels": { # The labels used for extra metadata and/or filtering.

470

"a_key": "A String",

471

},

472

"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.

473

"email": "A String", # The email address of the user when the user performed the action.

474

"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.

475

},

476

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

477

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

478

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

479

"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.

480

"email": "A String", # The email address of the user when the user performed the action.

481

"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.

482

},

483

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

484

"createTime": "A String", # Output only. The time at which the version was created.

485

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

486

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

487

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

488

},

489

"appAssociation": "A String", # How to handle well known App Association files.

490

"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.

491

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

492

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

493

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

494

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

495

"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"

496

},

497

],

498

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

499

"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.

500

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

501

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

502

"headers": { # Required. The additional headers to add to the response.

503

"a_key": "A String",

504

},

505

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

506

},

507

],

508

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

509

"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.

510

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

511

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

512

"path": "A String", # The URL path to rewrite the request to.

513

"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.

514

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

515

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

516

},

517

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

518

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

519

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

524

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

525

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

526

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

527

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

528

"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.

529

"email": "A String", # The email address of the user when the user performed the action.

530

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

531

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

532

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

533

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

534

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

<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.

</pre>

</div>

<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

2020-12-09 08:56:03 -0800

[diff] [blame^]

563

"updateTime": "A String", # Output only. The time at which the channel was last updated.

564

"labels": { # Text labels used for extra metadata and/or filtering.

565

"a_key": "A String",

566

},

567

"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.

568

"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.

569

"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.

570

"name": "A String", # The fully-qualified identifier of the Channel.

571

"createTime": "A String", # Output only. The time at which the channel was created.

572

"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.

573

"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.

574

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

575

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

576

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

577

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

578

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

579

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

580

"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.

581

"active": True or False, # If true, preview URLs are enabled for this version.

582

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

583

},

584

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

585

"labels": { # The labels used for extra metadata and/or filtering.

586

"a_key": "A String",

587

},

588

"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.

589

"email": "A String", # The email address of the user when the user performed the action.

590

"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.

591

},

592

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

593

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

594

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

595

"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.

596

"email": "A String", # The email address of the user when the user performed the action.

597

"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.

598

},

599

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

600

"createTime": "A String", # Output only. The time at which the version was created.

601

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

602

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

603

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

604

},

605

"appAssociation": "A String", # How to handle well known App Association files.

606

"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.

607

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

608

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

609

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

610

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

611

"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"

612

},

613

],

614

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

615

"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.

616

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

617

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

618

"headers": { # Required. The additional headers to add to the response.

619

"a_key": "A String",

620

},

621

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

622

},

623

],

624

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

625

"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.

626

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

627

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

628

"path": "A String", # The URL path to rewrite the request to.

629

"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.

630

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

631

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

632

},

633

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

634

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

635

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

640

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

641

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

642

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

643

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

644

"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.

645

"email": "A String", # The email address of the user when the user performed the action.

646

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

647

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

648

},

649

}

Dmitry Frenkel

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-12-09 08:56:03 -0800

[diff] [blame^]

661

"updateTime": "A String", # Output only. The time at which the channel was last updated.

662

"labels": { # Text labels used for extra metadata and/or filtering.

663

"a_key": "A String",

664

},

665

"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.

666

"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.

667

"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.

668

"name": "A String", # The fully-qualified identifier of the Channel.

669

"createTime": "A String", # Output only. The time at which the channel was created.

670

"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.

671

"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.

672

"message": "A String", # The deploy description when the release was created. The value can be up to 512 characters.

673

"version": { # A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. # Output only. The configuration and content that was released.

674

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

675

"email": "A String", # The email address of the user when the user performed the action.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame]

676

"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

2020-11-25 07:50:41 -0800

[diff] [blame]

677

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

678

"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.

679

"active": True or False, # If true, preview URLs are enabled for this version.

680

"expireTime": "A String", # Indicates the expiration time for previewing this version; preview URL requests received after this time will 404.

681

},

682

"status": "A String", # The deploy status of a version. For a successful deploy, call the [`CreateVersion`](sites.versions/create) endpoint to make a new version (`CREATED` status), [upload all desired files](sites.versions/populateFiles) to the version, then [update](sites.versions/patch) the version to the `FINALIZED` status. Note that if you leave the version in the `CREATED` state for more than 12 hours, the system will automatically mark the version as `ABANDONED`. You can also change the status of a version to `DELETED` by calling the [`DeleteVersion`](sites.versions/delete) endpoint.

683

"labels": { # The labels used for extra metadata and/or filtering.

684

"a_key": "A String",

685

},

686

"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.

687

"email": "A String", # The email address of the user when the user performed the action.

688

"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.

689

},

690

"name": "A String", # The unique identifier for a version, in the format: sites/site-name /versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint.

691

"fileCount": "A String", # Output only. The total number of files associated with the version. This value is calculated after a version is `FINALIZED`.

692

"finalizeTime": "A String", # Output only. The time at which the version was `FINALIZED`.

693

"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.

694

"email": "A String", # The email address of the user when the user performed the action.

695

"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.

696

},

697

"deleteTime": "A String", # Output only. The time at which the version was `DELETED`.

698

"createTime": "A String", # Output only. The time at which the version was created.

699

"config": { # The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific [priority order](/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

700

"i18n": { # If provided, i18n rewrites are enabled. # Optional. Defines i18n rewrite behavior.

701

"root": "A String", # Required. The user-supplied path where country and language specific content will be looked for within the public directory.

702

},

703

"appAssociation": "A String", # How to handle well known App Association files.

704

"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.

705

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

706

"statusCode": 42, # Required. The status HTTP code to return in the response. It must be a valid 3xx status code.

707

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

708

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

709

"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"

710

},

711

],

712

"cleanUrls": True or False, # Defines whether to drop the file extension from uploaded files.

713

"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.

714

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

715

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

716

"headers": { # Required. The additional headers to add to the response.

717

"a_key": "A String",

718

},

719

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

720

},

721

],

722

"trailingSlashBehavior": "A String", # Defines how to handle a trailing slash in the URL path.

723

"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.

724

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

725

"glob": "A String", # The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to match against the request URL path.

726

"path": "A String", # The URL path to rewrite the request to.

727

"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.

728

"serviceId": "A String", # Required. User-defined ID of the Cloud Run service.

729

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted. Defaults to `us-central1` if not supplied.

730

},

731

"function": "A String", # The function to proxy requests to. Must match the exported function name exactly.

732

"regex": "A String", # The user-supplied RE2 regular expression to match against the request URL path.

733

"dynamicLinks": True or False, # The request will be forwarded to Firebase Dynamic Links.

},

],

},

"versionBytes": "A String", # Output only. The total stored bytesize of the version. This value is calculated after a version is `FINALIZED`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

738

},

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame^]

739

"name": "A String", # Output only. The unique identifier for the release, in the format: sites/ site-name/releases/releaseID This name is provided in the response body when you call the [`CreateRelease`](sites.releases/create) endpoint.

740

"releaseTime": "A String", # Output only. The time at which the version is set to be public.

741

"type": "A String", # Explains the reason for the release. Specify a value for this field only when creating a `SITE_DISABLE` type release.

742

"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.

743

"email": "A String", # The email address of the user when the user performed the action.

744

"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

2020-11-24 15:48:03 -0800

[diff] [blame]

745

},

Yoshi Automation Bot