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

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

[diff] [blame]

81

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[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

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

[diff] [blame]

83

Yoshi Automation Bot

0bf565c

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

[diff] [blame]

84

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

85

<p class="firstline">Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default `live` channel and any active preview channels for the specified site.</p>

Bu Sun Kim

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

[diff] [blame]

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

3e17f89

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

[diff] [blame]

91

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

92

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

96

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[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

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

[diff] [blame]

98

99

Args:

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

100

parent: string, Required. The site or channel to which the release belongs, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID (required)

Bu Sun Kim

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

[diff] [blame]

101

body: object, The request body.

102

The object takes the form of:

103

yoshi-code-bot

2021-03-31 13:33:30 -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.

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

105

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

106

"name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

107

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

108

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

109

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

110

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

111

},

112

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

113

"version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.

114

"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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

115

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

116

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

117

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

118

{ # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

119

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

120

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

121

"a_key": "A String",

122

},

123

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

124

},

125

],

126

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

127

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

128

},

129

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

130

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

131

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

132

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

133

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

134

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

135

},

136

],

137

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

138

{ # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

139

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

140

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

141

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

142

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

143

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

144

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

145

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

146

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

},

},

],

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

151

},

152

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

153

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

154

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

155

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

156

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

157

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

158

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

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

},

162

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

163

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

164

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

165

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

166

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

167

},

168

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

169

"a_key": "A String",

170

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

171

"name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).

172

"preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).

Yoshi Automation Bot

0bf565c

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

[diff] [blame]

173

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

174

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

175

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

176

"status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) 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 [`DeleteVersion`](sites.versions/delete).

Yoshi Automation Bot

0bf565c

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

[diff] [blame]

177

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

Yoshi Automation Bot

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

[diff] [blame]

178

},

Bu Sun Kim

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

[diff] [blame]

179

}

180

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

181

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

Bu Sun Kim

2020-05-20 12:08:20 -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

yoshi-code-bot

2021-03-31 13:33:30 -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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

191

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

192

"name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

193

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

194

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

195

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

196

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

197

},

198

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

199

"version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.

200

"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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

201

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

202

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

203

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

204

{ # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

205

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

206

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

207

"a_key": "A String",

208

},

209

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

210

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

211

],

212

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

213

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

Yoshi Automation Bot

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

[diff] [blame]

214

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

215

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

216

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

217

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

218

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

219

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

220

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

221

},

222

],

223

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

224

{ # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

225

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

226

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

227

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

228

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

229

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

230

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

231

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

232

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

},

},

],

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

Yoshi Automation Bot

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

[diff] [blame]

237

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

238

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

239

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

240

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

241

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

242

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

243

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

244

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

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

},

248

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

249

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

250

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

251

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

252

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

253

},

254

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

255

"a_key": "A String",

256

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

257

"name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).

258

"preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

259

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

260

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

261

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

262

"status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) 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 [`DeleteVersion`](sites.versions/delete).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

263

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

264

},

265

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

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

[diff] [blame]

269

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

270

<pre>Lists the releases that have been created for the specified site or channel. When used to list releases for a site, this list includes releases for both the default `live` channel and any active preview channels for the specified site.

Bu Sun Kim

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

[diff] [blame]

271

272

Args:

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

273

parent: string, Required. The site or channel for which to list releases, in either of the following formats: - sites/SITE_ID - sites/SITE_ID/channels/CHANNEL_ID (required)

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

274

pageSize: integer, The maximum number of releases to return. The service may return a lower number if fewer releases exist than this maximum number. If unspecified, defaults to 100.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

275

pageToken: string, A token from a previous call to `releases.list` or `channels.releases.list` that tells the server where to resume listing.

Bu Sun Kim

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

[diff] [blame]

276

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

283

284

{

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

285

"nextPageToken": "A String", # The pagination token, if more results exist beyond the ones in this response. Include this token in your next call to `ListReleases`. Page tokens are short-lived and should not be stored.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

286

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

287

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

288

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

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

289

"name": "A String", # Output only. The unique identifier for the release, in either of the following formats: - sites/SITE_ID/releases/RELEASE_ID - sites/SITE_ID/channels/CHANNEL_ID/releases/RELEASE_ID This name is provided in the response body when you call [`releases.create`](sites.releases/create) or [`channels.releases.create`](sites.channels.releases/create).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

290

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

291

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

292

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

293

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

294

},

295

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

296

"version": { # A `Version` is a configuration and a collection of static files which determine how a site is displayed. # Output only. The configuration and content that was released.

297

"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](https://firebase.google.com/docs/hosting/full-config#hosting_priority_order). # The configuration for the behavior of the site. This configuration exists in the [`firebase.json`](https://firebase.google.com/docs/cli/#the_firebasejson_file) file.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

298

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

299

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

300

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

301

{ # A [`Header`](https://firebase.google.com/docs/hosting/full-config#headers) specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.

302

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

303

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

304

"a_key": "A String",

305

},

306

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

307

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

],

309

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

310

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

Yoshi Automation Bot

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

[diff] [blame]

311

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

312

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

313

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

314

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

315

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

316

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

317

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

318

},

319

],

320

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

321

{ # A [`Rewrite`](https://firebase.google.com/docs/hosting/full-config#rewrites) 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

322

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

323

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

yoshi-code-bot

2021-03-03 03:54:02 -0800

[diff] [blame]

324

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

325

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

326

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

327

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

328

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

329

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

},

},

],

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

Yoshi Automation Bot

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

[diff] [blame]

334

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

335

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

336

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

337

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

338

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

339

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

340

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

341

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

342

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

343

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

344

},

345

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

346

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

347

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

348

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

349

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

350

},

351

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

352

"a_key": "A String",

353

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

354

"name": "A String", # The fully-qualified resource name for the version, in the format: sites/ SITE_ID/versions/VERSION_ID This name is provided in the response body when you call [`CreateVersion`](sites.versions/create).

355

"preview": { # Deprecated in favor of [site channels](sites.channels). # Deprecated in favor of [site channels](sites.channels).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

356

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

357

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

358

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

359

"status": "A String", # The deploy status of the version. For a successful deploy, call [`CreateVersion`](sites.versions/create) 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 [`DeleteVersion`](sites.versions/delete).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

360

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

Bu Sun Kim