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.

101

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

102

# 512&nbsp;characters.

103

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

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

},

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

# type release.

117

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

118

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

119

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

120

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

121

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

122

# a release or finalizing a version.

123

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

124

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

125

# changed their email address or deleted their account.

126

},

127

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

128

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

129

# a release or finalizing a version.

130

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

131

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

132

# changed their email address or deleted their account.

133

},

134

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

135

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

136

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

137

# releasing it as the live version.

138

# this version will be accessible via a custom URL even

139

# if it is not the currently released version.

140

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

141

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

142

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

143

},

144

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

145

"a_key": "A String",

146

},

147

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

148

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

149

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

150

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

151

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

152

# <br>

153

# <br>For a successful deploy, call the

154

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

155

# (`CREATED` status),

156

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

157

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

158

# <br>

159

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

160

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

161

# `ABANDONED`.

162

# <br>

163

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

164

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

165

"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

166

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

167

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

168

# according to a specific

169

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

170

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

171

# request URL path matches the glob.

172

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

173

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

174

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

175

"a_key": "A String",

176

},

177

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

178

# URL path.

179

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

180

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

181

# against the request URL path.

182

},

183

],

184

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

185

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

186

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

187

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

188

# destination URL.

189

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

190

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

191

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

192

# configuration.

193

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

194

# name exactly.

195

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

196

# URL path.

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

},

207

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

208

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

209

# against the request URL path.

210

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

211

},

212

],

213

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

214

# location.

215

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

216

# configuration for returning an HTTP redirect response given a matching

217

# request URL path.

218

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

219

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

220

# against the request URL path.

221

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

222

# valid 3xx status code.

223

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

224

# URL path.

225

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

226

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

227

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

228

# rest of the URL.

229

# For example:

230

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

231

# <br>"statusCode": 301,

232

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

},

],

},

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

237

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

238

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

239

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

240

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

241

# a release or finalizing a version.

242

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

243

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

244

# changed their email address or deleted their account.

},

},

}

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.

267

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

268

# 512&nbsp;characters.

269

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

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

},

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

# type release.

283

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

284

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

285

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

286

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

287

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

288

# a release or finalizing a version.

289

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

290

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

291

# changed their email address or deleted their account.

292

},

293

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

294

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

295

# a release or finalizing a version.

296

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

297

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

298

# changed their email address or deleted their account.

299

},

300

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

301

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

302

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

303

# releasing it as the live version.

304

# this version will be accessible via a custom URL even

305

# if it is not the currently released version.

306

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

307

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

308

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

309

},

310

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

311

"a_key": "A String",

312

},

313

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

314

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

315

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

316

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

317

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

318

# <br>

319

# <br>For a successful deploy, call the

320

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

321

# (`CREATED` status),

322

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

323

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

324

# <br>

325

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

326

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

327

# `ABANDONED`.

328

# <br>

329

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

330

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

331

"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

332

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

333

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

334

# according to a specific

335

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

336

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

337

# request URL path matches the glob.

338

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

339

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

340

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

341

"a_key": "A String",

342

},

343

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

344

# URL path.

345

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

346

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

347

# against the request URL path.

348

},

349

],

350

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

351

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

352

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

353

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

354

# destination URL.

355

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

356

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

357

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

358

# configuration.

359

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

360

# name exactly.

361

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

362

# URL path.

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

},

373

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

374

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

375

# against the request URL path.

376

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

377

},

378

],

379

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

380

# location.

381

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

382

# configuration for returning an HTTP redirect response given a matching

383

# request URL path.

384

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

385

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

386

# against the request URL path.

387

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

388

# valid 3xx status code.

389

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

390

# URL path.

391

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

392

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

393

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

394

# rest of the URL.

395

# For example:

396

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

397

# <br>"statusCode": 301,

398

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

},

],

},

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

403

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

404

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

405

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

406

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

407

# a release or finalizing a version.

408

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

409

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

410

# changed their email address or deleted their account.

},

},

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

438

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

439

# 512&nbsp;characters.

440

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

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

},

446

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

447

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

448

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

449

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

450

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

451

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

452

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

453

# type release.

454

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

455

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

456

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

457

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

458

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

459

# a release or finalizing a version.

460

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

461

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

462

# changed their email address or deleted their account.

463

},

464

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

465

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

466

# a release or finalizing a version.

467

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

468

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

469

# changed their email address or deleted their account.

470

},

471

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

472

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

473

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

474

# releasing it as the live version.

475

# this version will be accessible via a custom URL even

476

# if it is not the currently released version.

477

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

478

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

479

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

480

},

481

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

482

"a_key": "A String",

483

},

484

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

485

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

486

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

487

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

488

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

489

# <br>

490

# <br>For a successful deploy, call the

491

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

492

# (`CREATED` status),

493

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

494

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

495

# <br>

496

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

497

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

498

# `ABANDONED`.

499

# <br>

500

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

501

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

502

"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

503

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

504

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

505

# according to a specific

506

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

507

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

508

# request URL path matches the glob.

509

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

510

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

511

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

512

"a_key": "A String",

513

},

514

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

515

# URL path.

516

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

517

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

518

# against the request URL path.

519

},

520

],

521

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

522

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

523

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

524

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

525

# destination URL.

526

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

527

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

528

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

529

# configuration.

530

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

531

# name exactly.

532

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

533

# URL path.

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

},

544

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

545

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

546

# against the request URL path.

547

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

548

},

549

],

550

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

551

# location.

552

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

553

# configuration for returning an HTTP redirect response given a matching

554

# request URL path.

555

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

556

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

557

# against the request URL path.

558

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

559

# valid 3xx status code.

560

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

561

# URL path.

562

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

563

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

564

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

565

# rest of the URL.

566

# For example:

567

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

568

# <br>"statusCode": 301,

569

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

},

],

},

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

574

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

575

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

576

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

577

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

578

# a release or finalizing a version.

579

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

580

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

581

# changed their email address or deleted their account.

582

},

583

},