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

<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.releases.html">releases</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body=None, versionName=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Creates a new release which makes the content of the specified version</p>

80

81

<code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Lists the releases that have been created on the specified site.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

88

<code class="details" id="create">create(parent, body=None, versionName=None, x__xgafv=None)</code>

89

<pre>Creates a new release which makes the content of the specified version

90

actively display on the appropriate URL(s).

91

92

Args:

93

parent: string, Required. The site that the release belongs to, in the format:

94

<code>sites/<var>site-name</var></code> (required)

95

body: object, The request body.

96

The object takes the form of:

97

98

{ # A `Release` is a particular

99

# [collection of configurations and files](sites.versions)

100

# that is set to be public at a particular time.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

101

"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.

102

# [static files](sites.versions.files) that determine how a site is displayed.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

103

"deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.

104

# a release or finalizing a version.

105

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

106

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

107

# changed their email address or deleted their account.

108

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

109

"finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.

110

# a release or finalizing a version.

111

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

112

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

113

# changed their email address or deleted their account.

114

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

115

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

116

"preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration

117

# specfies whether previewing is enabled for this site version. Version

118

# previews allow you to preview your site at a custom URL before

119

# releasing it as the live version.

120

# this version will be accessible via a custom URL even

121

# if it is not the currently released version.

122

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

123

"expireTime": "A String", # Indicates the expiration time for previewing this

124

# version; preview URL requests received after this time will 404.

125

},

126

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

127

"a_key": "A String",

128

},

129

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

130

"versionBytes": "A String", # Output only. The total stored bytesize of the version.

131

# <br>This value is calculated after a version is `FINALIZED`.

132

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

133

"status": "A String", # The deploy status of a version.

134

# <br>

135

# <br>For a successful deploy, call the

136

# [`CreateVersion`](sites.versions/create) endpoint to make a new version

137

# (`CREATED` status),

138

# [upload all desired files](sites.versions/populateFiles) to the version,

139

# then [update](sites.versions/patch) the version to the `FINALIZED` status.

140

# <br>

141

# <br>Note that if you leave the version in the `CREATED` state for more

142

# than 12&nbsp;hours, the system will automatically mark the version as

143

# `ABANDONED`.

144

# <br>

145

# <br>You can also change the status of a version to `DELETED` by calling the

146

# [`DeleteVersion`](sites.versions/delete) endpoint.

147

"config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists

148

# in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

149

# processed before serving content. The patterns are matched and applied

150

# according to a specific

151

# [priority order](/docs/hosting/full-config#hosting_priority_order).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"redirects": [ # A list of globs that will cause the response to redirect to another

153

# location.

154

{ # A [`redirect`](/docs/hosting/full-config#redirects) represents the

155

# configuration for returning an HTTP redirect response given a matching

156

# request URL path.

157

"glob": "A String", # The user-supplied [glob

158

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

159

# against the request URL path.

160

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

161

# valid 3xx status code.

162

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

163

# URL path.

164

"location": "A String", # Required. The value to put in the HTTP location header of the response.

165

# <br>The location can contain capture group values from the pattern using

166

# a `:` prefix to identify the segment and an optional `*` to capture the

167

# rest of the URL.

168

# For example:

169

# <code>"glob": "/:capture*",

170

# <br>"statusCode": 301,

171

# <br>"location": "https://example.com/foo/:capture"</code>

172

},

173

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

174

"headers": [ # A list of custom response headers that are added to the content if the

175

# request URL path matches the glob.

176

{ # A [`header`](/docs/hosting/full-config#headers) defines custom headers to

177

# add to a response should the request URL path match the pattern.

178

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

179

# URL path.

180

"glob": "A String", # The user-supplied [glob

181

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

182

# against the request URL path.

183

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

"a_key": "A String",

},

},

],

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

189

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

190

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

191

"rewrites": [ # A list of rewrites that will act as if the service were given the

192

# destination URL.

193

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal

194

# content rewrite on the version. If the pattern matches, the request will be

195

# handled as if it were to the destination path specified in the

196

# configuration.

197

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

198

# URL path.

199

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

200

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.

201

# Cloud Run service does not exist when setting or updating your Firebase

202

# Hosting configuration, then the request fails. Any errors from the Cloud Run

203

# service are passed to the end user (for example, if you delete a service, any

204

# requests directed to that service receive a `404` error).

205

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>

206

# Defaults to `us-central1` if not supplied.

207

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

208

},

209

"glob": "A String", # The user-supplied [glob

210

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

211

# against the request URL path.

212

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

213

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

214

# name exactly.

215

},

216

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

217

},

218

"name": "A String", # The unique identifier for a version, in the format:

219

# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>

220

# This name is provided in the response body when you call the

221

# [`CreateVersion`](../sites.versions/create) endpoint.

222

"createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.

223

# a release or finalizing a version.

224

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

225

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

226

# changed their email address or deleted their account.

227

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

228

"fileCount": "A String", # Output only. The total number of files associated with the version.

229

# <br>This value is calculated after a version is `FINALIZED`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

230

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

231

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

232

# 512&nbsp;characters.

233

"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.

234

# a release or finalizing a version.

235

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

236

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

237

# changed their email address or deleted their account.

238

},

239

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

240

"name": "A String", # Output only. The unique identifier for the release, in the format:

241

# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>

242

# This name is provided in the response body when you call the

243

# [`CreateRelease`](sites.releases/create) endpoint.

244

"type": "A String", # Explains the reason for the release.

245

# <br>Specify a value for this field only when creating a `SITE_DISABLE`

246

# type release.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

247

}

248

249

versionName: string, The unique identifier for a version, in the format:

250

<code>/sites/<var>site-name</var>/versions/<var>versionID</var></code>

251

The <var>site-name</var> in this version identifier must match the

252

<var>site-name</var> in the `parent` parameter.

253

<br>

254

<br>This query parameter must be empty if the `type` field in the

255

request body is `SITE_DISABLE`.

256

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

263

264

{ # A `Release` is a particular

265

# [collection of configurations and files](sites.versions)

266

# that is set to be public at a particular time.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

267

"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.

268

# [static files](sites.versions.files) that determine how a site is displayed.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

269

"deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.

270

# a release or finalizing a version.

271

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

272

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

273

# changed their email address or deleted their account.

274

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

275

"finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.

276

# a release or finalizing a version.

277

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

278

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

279

# changed their email address or deleted their account.

280

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

281

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

282

"preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration

283

# specfies whether previewing is enabled for this site version. Version

284

# previews allow you to preview your site at a custom URL before

285

# releasing it as the live version.

286

# this version will be accessible via a custom URL even

287

# if it is not the currently released version.

288

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

289

"expireTime": "A String", # Indicates the expiration time for previewing this

290

# version; preview URL requests received after this time will 404.

291

},

292

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

293

"a_key": "A String",

294

},

295

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

296

"versionBytes": "A String", # Output only. The total stored bytesize of the version.

297

# <br>This value is calculated after a version is `FINALIZED`.

298

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

299

"status": "A String", # The deploy status of a version.

300

# <br>

301

# <br>For a successful deploy, call the

302

# [`CreateVersion`](sites.versions/create) endpoint to make a new version

303

# (`CREATED` status),

304

# [upload all desired files](sites.versions/populateFiles) to the version,

305

# then [update](sites.versions/patch) the version to the `FINALIZED` status.

306

# <br>

307

# <br>Note that if you leave the version in the `CREATED` state for more

308

# than 12&nbsp;hours, the system will automatically mark the version as

309

# `ABANDONED`.

310

# <br>

311

# <br>You can also change the status of a version to `DELETED` by calling the

312

# [`DeleteVersion`](sites.versions/delete) endpoint.

313

"config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists

314

# in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

315

# processed before serving content. The patterns are matched and applied

316

# according to a specific

317

# [priority order](/docs/hosting/full-config#hosting_priority_order).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

318

"redirects": [ # A list of globs that will cause the response to redirect to another

319

# location.

320

{ # A [`redirect`](/docs/hosting/full-config#redirects) represents the

321

# configuration for returning an HTTP redirect response given a matching

322

# request URL path.

323

"glob": "A String", # The user-supplied [glob

324

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

325

# against the request URL path.

326

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

327

# valid 3xx status code.

328

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

329

# URL path.

330

"location": "A String", # Required. The value to put in the HTTP location header of the response.

331

# <br>The location can contain capture group values from the pattern using

332

# a `:` prefix to identify the segment and an optional `*` to capture the

333

# rest of the URL.

334

# For example:

335

# <code>"glob": "/:capture*",

336

# <br>"statusCode": 301,

337

# <br>"location": "https://example.com/foo/:capture"</code>

338

},

339

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

340

"headers": [ # A list of custom response headers that are added to the content if the

341

# request URL path matches the glob.

342

{ # A [`header`](/docs/hosting/full-config#headers) defines custom headers to

343

# add to a response should the request URL path match the pattern.

344

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

345

# URL path.

346

"glob": "A String", # The user-supplied [glob

347

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

348

# against the request URL path.

349

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

"a_key": "A String",

},

},

],

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

355

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

356

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

357

"rewrites": [ # A list of rewrites that will act as if the service were given the

358

# destination URL.

359

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal

360

# content rewrite on the version. If the pattern matches, the request will be

361

# handled as if it were to the destination path specified in the

362

# configuration.

363

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

364

# URL path.

365

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

366

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.

367

# Cloud Run service does not exist when setting or updating your Firebase

368

# Hosting configuration, then the request fails. Any errors from the Cloud Run

369

# service are passed to the end user (for example, if you delete a service, any

370

# requests directed to that service receive a `404` error).

371

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>

372

# Defaults to `us-central1` if not supplied.

373

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

374

},

375

"glob": "A String", # The user-supplied [glob

376

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

377

# against the request URL path.

378

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

379

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

380

# name exactly.

381

},

382

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

383

},

384

"name": "A String", # The unique identifier for a version, in the format:

385

# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>

386

# This name is provided in the response body when you call the

387

# [`CreateVersion`](../sites.versions/create) endpoint.

388

"createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.

389

# a release or finalizing a version.

390

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

391

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

392

# changed their email address or deleted their account.

393

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

394

"fileCount": "A String", # Output only. The total number of files associated with the version.

395

# <br>This value is calculated after a version is `FINALIZED`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

396

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

397

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

398

# 512&nbsp;characters.

399

"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.

400

# a release or finalizing a version.

401

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

402

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

403

# changed their email address or deleted their account.

404

},

405

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

406

"name": "A String", # Output only. The unique identifier for the release, in the format:

407

# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>

408

# This name is provided in the response body when you call the

409

# [`CreateRelease`](sites.releases/create) endpoint.

410

"type": "A String", # Explains the reason for the release.

411

# <br>Specify a value for this field only when creating a `SITE_DISABLE`

412

# type release.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

418

<pre>Lists the releases that have been created on the specified site.

419

420

Args:

421

parent: string, Required. The parent for which to list files, in the format:

422

<code>sites/<var>site-name</var></code> (required)

423

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

424

pageSize: integer, The page size to return. Defaults to 100.

425

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

432

433

{

434

"releases": [ # The list of hashes of files that still need to be uploaded, if any exist.

435

{ # A `Release` is a particular

436

# [collection of configurations and files](sites.versions)

437

# that is set to be public at a particular time.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

438

"version": { # A `Version` is the collection of configuration and # Output only. The configuration and content that was released.

439

# [static files](sites.versions.files) that determine how a site is displayed.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

440

"deleteUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `DELETED` the version.

441

# a release or finalizing a version.

442

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

443

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

444

# changed their email address or deleted their account.

445

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

446

"finalizeUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who `FINALIZED` the version.

447

# a release or finalizing a version.

448

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

449

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

450

# changed their email address or deleted their account.

451

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

452

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

453

"preview": { # Version preview configuration. If active and unexpired, # Version preview configuration for the site version. This configuration

454

# specfies whether previewing is enabled for this site version. Version

455

# previews allow you to preview your site at a custom URL before

456

# releasing it as the live version.

457

# this version will be accessible via a custom URL even

458

# if it is not the currently released version.

459

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

460

"expireTime": "A String", # Indicates the expiration time for previewing this

461

# version; preview URL requests received after this time will 404.

462

},

463

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

464

"a_key": "A String",

465

},

466

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

467

"versionBytes": "A String", # Output only. The total stored bytesize of the version.

468

# <br>This value is calculated after a version is `FINALIZED`.

469

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

470

"status": "A String", # The deploy status of a version.

471

# <br>

472

# <br>For a successful deploy, call the

473

# [`CreateVersion`](sites.versions/create) endpoint to make a new version

474

# (`CREATED` status),

475

# [upload all desired files](sites.versions/populateFiles) to the version,

476

# then [update](sites.versions/patch) the version to the `FINALIZED` status.

477

# <br>

478

# <br>Note that if you leave the version in the `CREATED` state for more

479

# than 12&nbsp;hours, the system will automatically mark the version as

480

# `ABANDONED`.

481

# <br>

482

# <br>You can also change the status of a version to `DELETED` by calling the

483

# [`DeleteVersion`](sites.versions/delete) endpoint.

484

"config": { # The configuration for how incoming requests to a site should be routed and # The configuration for the behavior of the site. This configuration exists

485

# in the [`firebase.json`](/docs/cli/#the_firebasejson_file) file.

486

# processed before serving content. The patterns are matched and applied

487

# according to a specific

488

# [priority order](/docs/hosting/full-config#hosting_priority_order).

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

489

"redirects": [ # A list of globs that will cause the response to redirect to another

490

# location.

491

{ # A [`redirect`](/docs/hosting/full-config#redirects) represents the

492

# configuration for returning an HTTP redirect response given a matching

493

# request URL path.

494

"glob": "A String", # The user-supplied [glob

495

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

496

# against the request URL path.

497

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

498

# valid 3xx status code.

499

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

500

# URL path.

501

"location": "A String", # Required. The value to put in the HTTP location header of the response.

502

# <br>The location can contain capture group values from the pattern using

503

# a `:` prefix to identify the segment and an optional `*` to capture the

504

# rest of the URL.

505

# For example:

506

# <code>"glob": "/:capture*",

507

# <br>"statusCode": 301,

508

# <br>"location": "https://example.com/foo/:capture"</code>

509

},

510

],

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

511

"headers": [ # A list of custom response headers that are added to the content if the

512

# request URL path matches the glob.

513

{ # A [`header`](/docs/hosting/full-config#headers) defines custom headers to

514

# add to a response should the request URL path match the pattern.

515

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

516

# URL path.

517

"glob": "A String", # The user-supplied [glob

518

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

519

# against the request URL path.

520

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

"a_key": "A String",

},

},

],

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

526

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

527

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

528

"rewrites": [ # A list of rewrites that will act as if the service were given the

529

# destination URL.

530

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal

531

# content rewrite on the version. If the pattern matches, the request will be

532

# handled as if it were to the destination path specified in the

533

# configuration.

534

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

535

# URL path.

536

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

537

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the # The request will be forwarded to Cloud Run.

538

# Cloud Run service does not exist when setting or updating your Firebase

539

# Hosting configuration, then the request fails. Any errors from the Cloud Run

540

# service are passed to the end user (for example, if you delete a service, any

541

# requests directed to that service receive a `404` error).

542

"region": "A String", # Optional. User-provided region where the Cloud Run service is hosted.<br>

543

# Defaults to `us-central1` if not supplied.

544

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

545

},

546

"glob": "A String", # The user-supplied [glob

547

# pattern](/docs/hosting/full-config#glob_pattern_matching) to match

548

# against the request URL path.

549

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

550

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

551

# name exactly.

552

},

553

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

554

},

555

"name": "A String", # The unique identifier for a version, in the format:

556

# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>

557

# This name is provided in the response body when you call the

558

# [`CreateVersion`](../sites.versions/create) endpoint.

559

"createUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the version.

560

# a release or finalizing a version.

561

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

562

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

563

# changed their email address or deleted their account.

564

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

565

"fileCount": "A String", # Output only. The total number of files associated with the version.

566

# <br>This value is calculated after a version is `FINALIZED`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

567

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

568

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

569

# 512&nbsp;characters.

570

"releaseUser": { # Contains metadata about the user who performed an action, such as creating # Output only. Identifies the user who created the release.

571

# a release or finalizing a version.

572

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

573

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has

574

# changed their email address or deleted their account.

575

},

576

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