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

2020-05-01 07:42:23 -0700

[diff] [blame]

78

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

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

80

Bu Sun Kim

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

[diff] [blame]

81

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

88

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

actively display on the appropriate URL(s).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

92

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

96

The object takes the form of:

97

98

{ # A `Release` is a particular

Bu Sun Kim

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

[diff] [blame]

99

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

100

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

Bu Sun Kim

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

2020-07-22 17:02:09 -0700

[diff] [blame]

103

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

105

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

# changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

107

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

Bu Sun Kim

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

[diff] [blame]

108

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

109

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

110

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

111

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

112

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

Bu Sun Kim

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

[diff] [blame]

113

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

114

"a_key": "A String",

115

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

116

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

117

"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

118

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

119

# processed before serving content. The URL request paths are matched against

120

# the specified URL patterns in the configuration, then Hosting applies the

121

# applicable configuration according to a specific

122

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

123

"headers": [ # An array of objects, where each object specifies a URL pattern that, if

124

# matched to the request URL path, triggers Hosting to apply the specified

125

# custom response headers.

126

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies

127

# a URL pattern that, if matched to the request URL path, triggers Hosting to

128

# apply the specified custom response headers.

129

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

130

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

131

# against the request URL path.

132

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

133

"a_key": "A String",

134

},

135

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

# URL path.

},

],

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a

140

# URL pattern that, if matched to the request URL path, triggers Hosting to

141

# respond with a redirect to the specified destination path.

142

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL

143

# pattern that, if matched to the request URL path, triggers Hosting to

144

# respond with a redirect to the specified destination path.

145

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

146

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

147

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

148

# rest of the URL.

149

# For example:

150

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

151

# <br>"statusCode": 301,

152

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

153

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

154

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

155

# against the request URL path.

156

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

157

# valid 3xx status code.

158

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

# URL path.

},

],

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

163

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL

164

# pattern that, if matched to the request URL path, triggers Hosting to

165

# respond as if the service were given the specified destination URL.

166

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL

167

# pattern that, if matched to the request URL path, triggers Hosting to

168

# respond as if the service were given the specified destination URL.

169

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

170

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

171

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

172

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

173

# against the request URL path.

174

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

175

# URL path.

176

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

177

# name exactly.

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

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

},

},

],

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

190

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

191

},

192

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

193

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

194

# a release or finalizing a version.

195

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

196

# changed their email address or deleted their account.

197

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

198

},

Bu Sun Kim

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

[diff] [blame]

199

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

200

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

201

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

202

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

203

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

Bu Sun Kim

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

[diff] [blame]

204

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

205

# <br>

206

# <br>For a successful deploy, call the

207

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

208

# (`CREATED` status),

209

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

210

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

211

# <br>

212

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

213

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

214

# `ABANDONED`.

215

# <br>

216

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

217

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

218

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

219

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

220

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

221

# releasing it as the live version.

222

# this version will be accessible via a custom URL even

223

# if it is not the currently released version.

224

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

225

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

226

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

Bu Sun Kim

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

[diff] [blame]

227

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

230

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

231

# changed their email address or deleted their account.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

232

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

Bu Sun Kim

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

[diff] [blame]

233

},

234

},

Bu Sun Kim

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

[diff] [blame]

235

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

236

# 512&nbsp;characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

237

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

238

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

239

# type release.

Bu Sun Kim

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

[diff] [blame]

240

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

241

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

242

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

243

# changed their email address or deleted their account.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

244

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

Bu Sun Kim

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

[diff] [blame]

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

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

249

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

250

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

Bu Sun Kim

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

[diff] [blame]

251

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

252

253

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

254

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

255

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

256

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

257

<br>

258

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

259

request body is `SITE_DISABLE`.

260

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

267

268

{ # A `Release` is a particular

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

273

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

274

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

275

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

276

# changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

277

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

Bu Sun Kim

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

[diff] [blame]

278

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

279

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

280

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

281

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

282

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

Bu Sun Kim

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

[diff] [blame]

283

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

284

"a_key": "A String",

285

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

286

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

287

"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

288

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

289

# processed before serving content. The URL request paths are matched against

290

# the specified URL patterns in the configuration, then Hosting applies the

291

# applicable configuration according to a specific

292

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

293

"headers": [ # An array of objects, where each object specifies a URL pattern that, if

294

# matched to the request URL path, triggers Hosting to apply the specified

295

# custom response headers.

296

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies

297

# a URL pattern that, if matched to the request URL path, triggers Hosting to

298

# apply the specified custom response headers.

299

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

300

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

301

# against the request URL path.

302

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

303

"a_key": "A String",

304

},

305

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

# URL path.

},

],

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a

310

# URL pattern that, if matched to the request URL path, triggers Hosting to

311

# respond with a redirect to the specified destination path.

312

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL

313

# pattern that, if matched to the request URL path, triggers Hosting to

314

# respond with a redirect to the specified destination path.

315

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

316

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

317

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

318

# rest of the URL.

319

# For example:

320

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

321

# <br>"statusCode": 301,

322

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

323

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

324

# [glob](/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

# URL path.

},

],

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

333

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL

334

# pattern that, if matched to the request URL path, triggers Hosting to

335

# respond as if the service were given the specified destination URL.

336

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL

337

# pattern that, if matched to the request URL path, triggers Hosting to

338

# respond as if the service were given the specified destination URL.

339

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

340

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

341

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

342

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

343

# against the request URL path.

344

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

345

# URL path.

346

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

347

# name exactly.

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

},

},

],

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

360

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

361

},

362

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

363

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

364

# a release or finalizing a version.

365

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

366

# changed their email address or deleted their account.

367

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

368

},

Bu Sun Kim

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

[diff] [blame]

369

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

370

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

371

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

372

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

373

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

Bu Sun Kim

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

[diff] [blame]

374

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

375

# <br>

376

# <br>For a successful deploy, call the

377

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

378

# (`CREATED` status),

379

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

380

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

381

# <br>

382

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

383

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

384

# `ABANDONED`.

385

# <br>

386

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

387

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

388

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

389

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

390

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

391

# releasing it as the live version.

392

# this version will be accessible via a custom URL even

393

# if it is not the currently released version.

394

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

395

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

396

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

Bu Sun Kim

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

[diff] [blame]

397

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

398

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

Bu Sun Kim

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

[diff] [blame]

399

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

400

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

401

# changed their email address or deleted their account.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

402

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

Bu Sun Kim

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

[diff] [blame]

403

},

404

},

Bu Sun Kim

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

[diff] [blame]

405

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

406

# 512&nbsp;characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

407

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

408

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

409

# type release.

Bu Sun Kim

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

[diff] [blame]

410

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

411

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

412

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

413

# changed their email address or deleted their account.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

414

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

Bu Sun Kim

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

[diff] [blame]

415

},

Bu Sun Kim

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

[diff] [blame]

416

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

417

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

418

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

419

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

420

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

Bu Sun Kim

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

[diff] [blame]

421

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

425

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

426

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

427

428

Args:

429

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

430

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

431

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

Bu Sun Kim

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

[diff] [blame]

432

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

433

x__xgafv: string, V1 error format.

434

Allowed values

435

1 - v1 error format

436

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

437

438

Returns:

439

An object of the form:

440

Bu Sun Kim

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

[diff] [blame]

441

{

442

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

443

{ # A `Release` is a particular

444

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

445

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

Bu Sun Kim

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

[diff] [blame]

446

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

447

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

448

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

Bu Sun Kim

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

[diff] [blame]

449

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

450

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

451

# changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

452

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

Bu Sun Kim

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

[diff] [blame]

453

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

454

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

455

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

456

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

457

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

Bu Sun Kim

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

[diff] [blame]

458

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

459

"a_key": "A String",

460

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

461

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

462

"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

463

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

464

# processed before serving content. The URL request paths are matched against

465

# the specified URL patterns in the configuration, then Hosting applies the

466

# applicable configuration according to a specific

467

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

468

"headers": [ # An array of objects, where each object specifies a URL pattern that, if

469

# matched to the request URL path, triggers Hosting to apply the specified

470

# custom response headers.

471

{ # A [`header`](/docs/hosting/full-config#headers) is an object that specifies

472

# a URL pattern that, if matched to the request URL path, triggers Hosting to

473

# apply the specified custom response headers.

474

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

475

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

476

# against the request URL path.

477

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

478

"a_key": "A String",

479

},

480

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

# URL path.

},

],

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a

485

# URL pattern that, if matched to the request URL path, triggers Hosting to

486

# respond with a redirect to the specified destination path.

487

{ # A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL

488

# pattern that, if matched to the request URL path, triggers Hosting to

489

# respond with a redirect to the specified destination path.

490

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

491

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

492

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

493

# rest of the URL.

494

# For example:

495

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

496

# <br>"statusCode": 301,

497

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

498

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

499

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

500

# against the request URL path.

501

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

502

# valid 3xx status code.

503

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

# URL path.

},

],

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

508

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL

509

# pattern that, if matched to the request URL path, triggers Hosting to

510

# respond as if the service were given the specified destination URL.

511

{ # A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL

512

# pattern that, if matched to the request URL path, triggers Hosting to

513

# respond as if the service were given the specified destination URL.

514

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

515

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

516

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

517

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

518

# against the request URL path.

519

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

520

# URL path.

521

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

522

# name exactly.

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

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

},

},

],

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

535

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

536

},

537

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

538

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

539

# a release or finalizing a version.

540

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

541

# changed their email address or deleted their account.

542

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

543

},

Bu Sun Kim

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

[diff] [blame]

544

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

545

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

546

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

547

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

548

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

Bu Sun Kim

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

[diff] [blame]

549

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

550

# <br>

551

# <br>For a successful deploy, call the

552

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

553

# (`CREATED` status),

554

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

555

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

556

# <br>

557

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

558

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

559

# `ABANDONED`.

560

# <br>

561

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

562

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

563

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

564

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

565

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

566

# releasing it as the live version.

567

# this version will be accessible via a custom URL even

568

# if it is not the currently released version.

569

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

570

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

571

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

Bu Sun Kim

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

[diff] [blame]

572

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

573

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

Bu Sun Kim

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

[diff] [blame]

574

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

575

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

576

# changed their email address or deleted their account.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

577

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

Bu Sun Kim

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

[diff] [blame]

578

},

579

},

Bu Sun Kim

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

[diff] [blame]

580

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

581

# 512&nbsp;characters.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

582

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

583

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

584

# type release.

Bu Sun Kim

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

[diff] [blame]

585

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

586

# a release or finalizing a version.

Bu Sun Kim

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

[diff] [blame]

587

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

588

# changed their email address or deleted their account.

Bu Sun Kim