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

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

[diff] [blame]

78

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

79

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

80

Dan O'Meara

dd49464

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

[diff] [blame]

81

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

Dmitry Frenkel

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

[diff] [blame]

82

<p class="firstline">Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).</p>

Bu Sun Kim

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

[diff] [blame]

83

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

84

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

Bu Sun Kim

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

[diff] [blame]

85

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

86

87

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

88

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

89

<h3>Method Details</h3>

90

Dmitry Frenkel

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

[diff] [blame]

91

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

92

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

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

[diff] [blame]

96

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

Dmitry Frenkel

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

[diff] [blame]

97

<pre>Creates a new release which makes the content of the specified version actively display on the appropriate URL(s).

Bu Sun Kim

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

[diff] [blame]

98

99

Args:

Dmitry Frenkel

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

[diff] [blame]

100

parent: string, Required. The site that the release belongs to, in the format: sites/ site-name (required)

Dan O'Meara

dd49464

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

[diff] [blame]

101

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

102

The object takes the form of:

103

Dmitry Frenkel

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

[diff] [blame]

104

{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.

105

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

106

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

107

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

108

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

109

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

110

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

111

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

112

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

113

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

114

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

115

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.

116

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

117

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

118

},

119

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

120

},

121

],

122

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

123

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

124

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

125

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

126

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

127

"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"

128

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

129

},

130

],

131

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

132

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

133

"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

134

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

135

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

136

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

137

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

"a_key": "A String",

},

},

],

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

143

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

144

},

145

},

146

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

147

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

Dmitry Frenkel

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

[diff] [blame]

148

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

Bu Sun Kim

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

[diff] [blame]

149

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

Dmitry Frenkel

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

[diff] [blame]

150

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

151

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

152

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

153

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

154

"preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.

Dmitry Frenkel

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

[diff] [blame]

155

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

156

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

Dmitry Frenkel

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

[diff] [blame]

157

},

158

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

159

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

160

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

161

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

162

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

163

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

164

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

165

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

166

},

Bu Sun Kim

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

[diff] [blame]

167

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

168

"a_key": "A String",

169

},

Bu Sun Kim

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

[diff] [blame]

170

},

Dmitry Frenkel

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

[diff] [blame]

171

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

172

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

Dmitry Frenkel

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

[diff] [blame]

173

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

174

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

175

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

176

},

177

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

178

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

179

}

Bu Sun Kim

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

[diff] [blame]

180

Dmitry Frenkel

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

[diff] [blame]

181

versionName: string, The unique identifier for a version, in the format: /sites/site-name /versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter. This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`.

Bu Sun Kim

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

[diff] [blame]

182

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

189

Dmitry Frenkel

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

[diff] [blame]

190

{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.

191

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

192

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

193

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

194

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

195

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

196

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

197

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

198

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

199

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

200

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

201

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.

202

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

203

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

204

},

205

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

206

},

207

],

208

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

209

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

210

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

211

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

212

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

213

"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"

214

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

215

},

216

],

217

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

218

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

219

"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

220

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

221

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

222

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

223

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

"a_key": "A String",

},

},

],

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

229

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

230

},

231

},

232

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

233

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

Dmitry Frenkel

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

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

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

Dmitry Frenkel

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

[diff] [blame]

236

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

237

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

238

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

239

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

240

"preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.

Dmitry Frenkel

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

[diff] [blame]

241

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

242

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

Dmitry Frenkel

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

[diff] [blame]

243

},

244

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

245

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

246

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

247

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

248

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

249

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

250

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

251

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

252

},

Bu Sun Kim

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

[diff] [blame]

253

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

254

"a_key": "A String",

255

},

Bu Sun Kim

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

[diff] [blame]

256

},

Dmitry Frenkel

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

[diff] [blame]

257

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

258

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

Dmitry Frenkel

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

[diff] [blame]

259

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

260

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

261

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

262

},

263

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

264

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

265

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

269

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

Bu Sun Kim

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

[diff] [blame]

270

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

271

272

Args:

Dmitry Frenkel

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

[diff] [blame]

273

parent: string, Required. The parent for which to list files, in the format: sites/site-name (required)

Bu Sun Kim

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

[diff] [blame]

274

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

275

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

Bu Sun Kim

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

[diff] [blame]

276

x__xgafv: string, V1 error format.

277

Allowed values

278

1 - v1 error format

279

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

280

281

Returns:

282

An object of the form:

283

Bu Sun Kim

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

[diff] [blame]

284

{

285

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

Dmitry Frenkel

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

[diff] [blame]

286

{ # A `Release` is a particular [collection of configurations and files](sites.versions) that is set to be public at a particular time.

287

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

288

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

289

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

290

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

291

"rewrites": [ # An array of objects (called rewrite rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.

292

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

293

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

294

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

295

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

296

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

297

"run": { # A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a `404` error). # The request will be forwarded to Cloud Run.

298

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

299

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

300

},

301

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

302

},

303

],

304

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

305

"redirects": [ # An array of objects (called redirect rules), where each rule specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.

306

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

307

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

308

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

309

"location": "A String", # Required. The value to put in the HTTP location header of the response. The location can contain capture group values from the pattern using a `:` prefix to identify the segment and an optional `*` to capture the rest of the URL. For example: "glob": "/:capture*", "statusCode": 301, "location": "https://example.com/foo/:capture"

310

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

311

},

312

],

313

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

314

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

315

"headers": [ # An array of objects, where each object specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

316

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

317

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

318

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

319

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

"a_key": "A String",

},

},

],

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

325

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

326

},

327

},

328

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

329

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

Dmitry Frenkel

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

[diff] [blame]

330

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

Bu Sun Kim

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

[diff] [blame]

331

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

Dmitry Frenkel

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

[diff] [blame]

332

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

Bu Sun Kim

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

[diff] [blame]

333

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

334

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

335

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

336

"preview": { # Version preview configuration. If active and unexpired, this version will be accessible via a custom URL even if it is not the currently released version. Deprecated in favor of site channels. # Deprecated in favor of site channels. Version preview configuration for the site version. This configuration specifies whether previewing is enabled for this site version. Version previews allow you to preview your site at a custom URL before releasing it as the live version.

Dmitry Frenkel

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

[diff] [blame]

337

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

338

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

Dmitry Frenkel

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

[diff] [blame]

339

},

340

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

341

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

342

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

343

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

344

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

345

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

346

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

347

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

348

},

Bu Sun Kim

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

[diff] [blame]

349

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

350

"a_key": "A String",

351

},

Bu Sun Kim

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

[diff] [blame]

352

},

Dmitry Frenkel

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

[diff] [blame]

353

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

354

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

Dmitry Frenkel

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

[diff] [blame]

355

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

356

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

357

"imageUrl": "A String", # A profile image URL for the user. May not be present if the user has changed their email address or deleted their account.

358

},

359

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

360

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

361

},

362

],

Dmitry Frenkel

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

[diff] [blame]

363

"nextPageToken": "A String", # If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases.

Bu Sun Kim