Blame - docs/dyn/compute_beta.regionUrlMaps.html - platform/external/python/google-api-python-client

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

[diff] [blame]

99

<code><a href="#update">update(project, region, urlMap, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Updates the specified UrlMap resource with the data included in the request.</p>

101

Dan O'Meara

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

[diff] [blame]

102

<code><a href="#validate">validate(project, region, urlMap, body=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>

104

<h3>Method Details</h3>

105

106

<code class="details" id="delete">delete(project, region, urlMap, requestId=None)</code>

107

<pre>Deletes the specified UrlMap resource.

108

109

Args:

110

project: string, Project ID for this request. (required)

111

region: string, Name of the region scoping this request. (required)

112

urlMap: string, Name of the UrlMap resource to delete. (required)

113

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

114

115

Returns:

116

An object of the form:

117

118

{ # Represents an Operation resource.

119

#

Dan O'Meara

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

[diff] [blame]

120

# Google Compute Engine has three Operation resources:

121

#

122

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

123

#

Bu Sun Kim

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

[diff] [blame]

124

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

125

#

126

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

127

# - For global operations, use the `globalOperations` resource.

128

# - For regional operations, use the `regionOperations` resource.

129

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

130

#

Dan O'Meara

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

[diff] [blame]

131

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

132

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

133

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

134

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

135

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

136

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

137

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

138

{

Bu Sun Kim

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

[diff] [blame]

139

"code": "A String", # [Output Only] The error type identifier for this error.

140

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

141

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

142

},

143

],

144

},

Bu Sun Kim

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

[diff] [blame]

145

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

146

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

147

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

148

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

149

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

150

"name": "A String", # [Output Only] Name of the operation.

151

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

152

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

153

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

154

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

155

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

156

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

157

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

158

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

159

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

160

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

161

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

162

{

163

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

164

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

165

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

166

{

167

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

168

"value": "A String", # [Output Only] A warning data value corresponding to the key.

169

},

170

],

171

"message": "A String", # [Output Only] A human-readable description of the warning code.

172

},

173

],

174

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(project, region, urlMap)</code>

180

<pre>Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

181

182

Args:

183

project: string, Project ID for this request. (required)

184

region: string, Name of the region scoping this request. (required)

185

urlMap: string, Name of the UrlMap resource to return. (required)

186

187

Returns:

188

An object of the form:

189

Dan O'Meara

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

[diff] [blame]

190

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

191

#

192

# Google Compute Engine has two URL Map resources:

193

#

194

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

195

#

196

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

197

#

198

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

199

#

200

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

201

#

202

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

203

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

204

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

205

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

206

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

207

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

208

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

209

# Default is false.

210

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

211

"A String",

Bu Sun Kim

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

[diff] [blame]

212

],

Bu Sun Kim

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

[diff] [blame]

213

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

214

"A String",

215

],

216

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

217

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

218

"A String",

219

],

220

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

221

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

222

"A String",

223

],

224

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

225

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

226

"A String",

227

],

228

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

229

},

230

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

231

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

232

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

233

"httpStatus": 42, # The HTTP status code used to abort the request.

234

# The value must be between 200 and 599 inclusive.

235

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

236

# The value must be between 0.0 and 100.0 inclusive.

237

},

238

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

239

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

240

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

241

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

242

},

243

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

244

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

245

},

246

},

Bu Sun Kim

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

[diff] [blame]

247

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

248

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

249

},

250

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

251

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

252

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

253

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

254

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

255

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

256

},

Bu Sun Kim

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

[diff] [blame]

257

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

258

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

259

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

260

# -

261

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

262

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

263

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

264

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

265

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

266

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

267

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

268

"A String",

Bu Sun Kim

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

[diff] [blame]

269

],

270

},

Bu Sun Kim

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

[diff] [blame]

271

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

272

# If not specified, will use the largest timeout among all backend services associated with the route.

273

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

274

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

275

},

276

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

277

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

278

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

279

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

280

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

281

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

282

},

Bu Sun Kim

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

[diff] [blame]

283

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

284

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

285

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

286

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

287

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

288

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

289

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

290

{ # Specification determining how headers are added to requests or responses.

291

"headerName": "A String", # The name of the header.

292

"headerValue": "A String", # The value of the header to add.

293

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

294

# The default value is false.

295

},

296

],

297

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

298

"A String",

299

],

300

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

301

{ # Specification determining how headers are added to requests or responses.

302

"headerName": "A String", # The name of the header.

303

"headerValue": "A String", # The value of the header to add.

304

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

305

# The default value is false.

306

},

307

],

308

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

313

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

314

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

315

},

316

],

Bu Sun Kim

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

[diff] [blame]

317

},

318

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

319

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

320

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

321

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

322

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

323

# The value must be between 1 and 255 characters.

324

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

325

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

326

# The default is set to false.

327

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

328

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

329

# The value must be between 1 and 1024 characters.

330

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

331

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

332

# The value must be between 1 and 1024 characters.

333

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

334

# Supported values are:

335

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

336

# - FOUND, which corresponds to 302.

337

# - SEE_OTHER which corresponds to 303.

338

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

339

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

340

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

341

# The default is set to false.

342

},

343

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

344

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

345

#

346

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

347

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

348

# The headerAction specified here take effect after headerAction specified under pathMatcher.

349

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

350

{ # Specification determining how headers are added to requests or responses.

351

"headerName": "A String", # The name of the header.

352

"headerValue": "A String", # The value of the header to add.

353

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

354

# The default value is false.

355

},

356

],

357

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

358

"A String",

359

],

360

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

361

{ # Specification determining how headers are added to requests or responses.

362

"headerName": "A String", # The name of the header.

363

"headerValue": "A String", # The value of the header to add.

364

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

365

# The default value is false.

366

},

367

],

368

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

373

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

374

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

375

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

376

"A String",

377

],

378

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

379

},

380

],

381

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

382

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

383

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

384

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

385

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

386

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

387

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

388

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

389

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

390

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

391

# Default is false.

392

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

393

"A String",

394

],

395

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

396

"A String",

397

],

398

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

399

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

400

"A String",

401

],

402

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

403

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

404

"A String",

405

],

406

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

407

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

408

"A String",

409

],

410

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

411

},

412

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

413

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

414

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

415

"httpStatus": 42, # The HTTP status code used to abort the request.

416

# The value must be between 200 and 599 inclusive.

417

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

418

# The value must be between 0.0 and 100.0 inclusive.

419

},

420

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

421

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

422

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

423

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

424

},

425

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

426

# The value must be between 0.0 and 100.0 inclusive.

427

},

428

},

429

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

430

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

431

},

432

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

433

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

434

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

435

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

436

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

437

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

438

},

439

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

440

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

441

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

442

# -

443

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

444

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

445

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

446

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

447

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

448

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

449

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

454

# If not specified, will use the largest timeout among all backend services associated with the route.

455

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

456

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

457

},

458

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

459

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

460

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

461

# The value must be between 1 and 255 characters.

462

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

463

# The value must be between 1 and 1024 characters.

464

},

465

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

466

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

467

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

468

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

469

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

470

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

471

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

472

{ # Specification determining how headers are added to requests or responses.

473

"headerName": "A String", # The name of the header.

474

"headerValue": "A String", # The value of the header to add.

475

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

476

# The default value is false.

477

},

478

],

479

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

480

"A String",

481

],

482

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

483

{ # Specification determining how headers are added to requests or responses.

484

"headerName": "A String", # The name of the header.

485

"headerValue": "A String", # The value of the header to add.

486

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

487

# The default value is false.

488

},

489

],

490

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

495

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

496

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

501

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

502

# - compute/v1/projects/project/global/backendServices/backendService

503

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

504

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

505

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

506

# - compute.backendBuckets.use

507

# - compute.backendServices.use

508

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

509

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

510

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

511

# The value must be between 1 and 255 characters.

512

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

513

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

514

# The default is set to false.

515

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

516

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

517

# The value must be between 1 and 1024 characters.

518

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

519

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

520

# The value must be between 1 and 1024 characters.

521

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

522

# Supported values are:

523

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

524

# - FOUND, which corresponds to 302.

525

# - SEE_OTHER which corresponds to 303.

526

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

527

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

528

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

529

# The default is set to false.

530

},

531

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

532

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

533

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

534

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

535

{ # Specification determining how headers are added to requests or responses.

536

"headerName": "A String", # The name of the header.

537

"headerValue": "A String", # The value of the header to add.

538

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

539

# The default value is false.

540

},

541

],

542

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

543

"A String",

544

],

545

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

546

{ # Specification determining how headers are added to requests or responses.

547

"headerName": "A String", # The name of the header.

548

"headerValue": "A String", # The value of the header to add.

549

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

550

# The default value is false.

551

},

552

],

553

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

558

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

559

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

560

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

561

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

562

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

563

"A String",

564

],

565

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

566

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

567

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

568

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

569

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

570

# Default is false.

571

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

572

"A String",

573

],

574

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

575

"A String",

576

],

577

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

578

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

579

"A String",

580

],

581

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

582

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

583

"A String",

584

],

585

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

586

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

587

"A String",

588

],

589

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

590

},

591

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

592

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

593

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

594

"httpStatus": 42, # The HTTP status code used to abort the request.

595

# The value must be between 200 and 599 inclusive.

596

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

597

# The value must be between 0.0 and 100.0 inclusive.

598

},

599

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

600

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

601

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

602

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

603

},

604

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

605

# The value must be between 0.0 and 100.0 inclusive.

606

},

607

},

608

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

609

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

610

},

611

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

612

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

613

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

614

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

615

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

616

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

617

},

618

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

619

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

620

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

621

# -

622

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

623

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

624

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

625

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

626

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

627

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

628

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

633

# If not specified, will use the largest timeout among all backend services associated with the route.

634

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

635

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

636

},

637

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

638

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

639

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

640

# The value must be between 1 and 255 characters.

641

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

642

# The value must be between 1 and 1024 characters.

643

},

644

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

645

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

646

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

647

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

648

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

649

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

650

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

651

{ # Specification determining how headers are added to requests or responses.

652

"headerName": "A String", # The name of the header.

653

"headerValue": "A String", # The value of the header to add.

654

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

655

# The default value is false.

656

},

657

],

658

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

659

"A String",

660

],

661

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

662

{ # Specification determining how headers are added to requests or responses.

663

"headerName": "A String", # The name of the header.

664

"headerValue": "A String", # The value of the header to add.

665

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

666

# The default value is false.

667

},

668

],

669

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

674

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

675

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

680

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

681

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

682

# If urlRedirect is specified, service or routeAction must not be set.

683

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

684

# The value must be between 1 and 255 characters.

685

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

686

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

687

# The default is set to false.

688

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

689

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

690

# The value must be between 1 and 1024 characters.

691

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

692

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

693

# The value must be between 1 and 1024 characters.

694

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

695

# Supported values are:

696

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

697

# - FOUND, which corresponds to 302.

698

# - SEE_OTHER which corresponds to 303.

699

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

700

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

701

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

702

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

707

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

708

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

709

"description": "A String", # The short description conveying the intent of this routeRule.

710

# The description can have a maximum length of 1024 characters.

711

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

712

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

713

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

714

{ # Specification determining how headers are added to requests or responses.

715

"headerName": "A String", # The name of the header.

716

"headerValue": "A String", # The value of the header to add.

717

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

718

# The default value is false.

719

},

720

],

721

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

722

"A String",

723

],

724

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

725

{ # Specification determining how headers are added to requests or responses.

726

"headerName": "A String", # The name of the header.

727

"headerValue": "A String", # The value of the header to add.

728

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

729

# The default value is false.

730

},

731

],

732

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

738

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

739

# fullPathMatch must be between 1 and 1024 characters.

740

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

741

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

742

{ # matchRule criteria for request header matches.

743

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

744

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

745

"headerName": "A String", # The name of the HTTP header to match.

746

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

747

# For matching a request's method, use the headerName ":method".

748

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

749

# The default setting is false.

750

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

751

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

752

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

753

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

754

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

755

# For example for a range [-5, 0]

756

# - -3 will match.

757

# - 0 will not match.

758

# - 0.25 will not match.

759

# - -3someString will not match.

760

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

761

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

762

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

763

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

764

},

765

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

766

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

767

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

768

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

769

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

770

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

771

},

772

],

773

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

774

# The default value is false.

775

# ignoreCase must not be used with regexMatch.

776

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

777

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

778

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

779

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

780

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

781

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

782

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

783

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

784

# This list must not be empty and can have at the most 64 entries.

785

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

786

"name": "A String", # Name of metadata label.

787

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

788

"value": "A String", # The value of the label must match the specified value.

789

# value can have a maximum length of 1024 characters.

790

},

791

],

792

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

793

# Supported values are:

794

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

795

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

796

},

797

],

798

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

799

# The value must be between 1 and 1024 characters.

800

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

801

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

802

{ # HttpRouteRuleMatch criteria for a request's query parameter.

803

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

804

# Only one of presentMatch, exactMatch or regexMatch must be set.

805

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

806

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

807

# Only one of presentMatch, exactMatch or regexMatch must be set.

808

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

809

# Only one of presentMatch, exactMatch or regexMatch must be set.

810

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

811

},

812

],

813

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

814

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

815

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

816

},

817

],

818

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

819

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

820

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

821

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

822

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

823

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

824

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

825

# Default is false.

826

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

827

"A String",

828

],

829

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

830

"A String",

831

],

832

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

833

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

834

"A String",

835

],

836

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

837

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

838

"A String",

839

],

840

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

841

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

842

"A String",

843

],

844

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

845

},

846

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

847

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

848

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

849

"httpStatus": 42, # The HTTP status code used to abort the request.

850

# The value must be between 200 and 599 inclusive.

851

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

852

# The value must be between 0.0 and 100.0 inclusive.

853

},

854

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

855

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

856

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

857

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

858

},

859

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

860

# The value must be between 0.0 and 100.0 inclusive.

861

},

862

},

863

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

864

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

865

},

866

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

867

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

868

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

869

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

870

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

871

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

872

},

873

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

874

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

875

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

876

# -

877

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

878

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

879

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

880

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

881

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

882

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

883

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

888

# If not specified, will use the largest timeout among all backend services associated with the route.

889

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

890

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

891

},

892

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

893

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

894

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

895

# The value must be between 1 and 255 characters.

896

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

897

# The value must be between 1 and 1024 characters.

898

},

899

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

900

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

901

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

902

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

903

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

904

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

905

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

906

{ # Specification determining how headers are added to requests or responses.

907

"headerName": "A String", # The name of the header.

908

"headerValue": "A String", # The value of the header to add.

909

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

910

# The default value is false.

911

},

912

],

913

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

914

"A String",

915

],

916

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

917

{ # Specification determining how headers are added to requests or responses.

918

"headerName": "A String", # The name of the header.

919

"headerValue": "A String", # The value of the header to add.

920

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

921

# The default value is false.

922

},

923

],

924

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

929

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

930

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

935

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

936

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

937

# If urlRedirect is specified, service or routeAction must not be set.

938

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

939

# The value must be between 1 and 255 characters.

940

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

941

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

942

# The default is set to false.

943

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

944

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

945

# The value must be between 1 and 1024 characters.

946

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

947

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

948

# The value must be between 1 and 1024 characters.

949

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

950

# Supported values are:

951

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

952

# - FOUND, which corresponds to 302.

953

# - SEE_OTHER which corresponds to 303.

954

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

955

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

956

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

957

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

964

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

965

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

966

{ # Message for the expected URL mappings.

967

"description": "A String", # Description of this test case.

968

"host": "A String", # Host portion of the URL.

969

"path": "A String", # Path portion of the URL.

970

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

971

},

972

],

973

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

977

<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

978

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

979

980

Args:

981

project: string, Project ID for this request. (required)

982

region: string, Name of the region scoping this request. (required)

Dan O'Meara

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

[diff] [blame]

983

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

984

The object takes the form of:

985

Dan O'Meara

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

[diff] [blame]

986

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

987

#

988

# Google Compute Engine has two URL Map resources:

989

#

990

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

991

#

992

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

993

#

994

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

995

#

996

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

997

#

998

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

999

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1000

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

1001

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1002

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

1003

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

1004

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

1005

# Default is false.

1006

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1007

"A String",

Bu Sun Kim

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

[diff] [blame]

1008

],

Bu Sun Kim

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

[diff] [blame]

1009

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1010

"A String",

1011

],

1012

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1013

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1014

"A String",

1015

],

1016

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1017

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1018

"A String",

1019

],

1020

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

1021

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1022

"A String",

1023

],

1024

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1025

},

1026

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

1027

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1028

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

1029

"httpStatus": 42, # The HTTP status code used to abort the request.

1030

# The value must be between 200 and 599 inclusive.

1031

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1032

# The value must be between 0.0 and 100.0 inclusive.

1033

},

1034

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

1035

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

1036

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1037

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1038

},

1039

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1040

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1041

},

1042

},

Bu Sun Kim

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

[diff] [blame]

1043

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

1044

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1045

},

1046

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1047

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1048

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

1049

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

1050

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1051

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

1052

},

Bu Sun Kim

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

[diff] [blame]

1053

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1054

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

1055

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1056

# -

1057

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1058

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1059

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

1060

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1061

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1062

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1063

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

1064

"A String",

Bu Sun Kim

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

[diff] [blame]

1065

],

1066

},

Bu Sun Kim

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

[diff] [blame]

1067

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

1068

# If not specified, will use the largest timeout among all backend services associated with the route.

1069

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1070

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1071

},

1072

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

1073

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

1074

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

1075

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1076

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

1077

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1078

},

Bu Sun Kim

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

[diff] [blame]

1079

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

1080

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

1081

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

1082

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

1083

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1084

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1085

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1086

{ # Specification determining how headers are added to requests or responses.

1087

"headerName": "A String", # The name of the header.

1088

"headerValue": "A String", # The value of the header to add.

1089

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1090

# The default value is false.

1091

},

1092

],

1093

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1094

"A String",

1095

],

1096

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1097

{ # Specification determining how headers are added to requests or responses.

1098

"headerName": "A String", # The name of the header.

1099

"headerValue": "A String", # The value of the header to add.

1100

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1101

# The default value is false.

1102

},

1103

],

1104

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

1109

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

1110

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

1111

},

1112

],

Bu Sun Kim

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

[diff] [blame]

1113

},

1114

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

1115

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1116

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1117

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1118

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1119

# The value must be between 1 and 255 characters.

1120

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

1121

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1122

# The default is set to false.

1123

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1124

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1125

# The value must be between 1 and 1024 characters.

1126

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1127

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1128

# The value must be between 1 and 1024 characters.

1129

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1130

# Supported values are:

1131

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1132

# - FOUND, which corresponds to 302.

1133

# - SEE_OTHER which corresponds to 303.

1134

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1135

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1136

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

1137

# The default is set to false.

1138

},

1139

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1140

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

1141

#

1142

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

1143

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1144

# The headerAction specified here take effect after headerAction specified under pathMatcher.

1145

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1146

{ # Specification determining how headers are added to requests or responses.

1147

"headerName": "A String", # The name of the header.

1148

"headerValue": "A String", # The value of the header to add.

1149

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1150

# The default value is false.

1151

},

1152

],

1153

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1154

"A String",

1155

],

1156

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1157

{ # Specification determining how headers are added to requests or responses.

1158

"headerName": "A String", # The name of the header.

1159

"headerValue": "A String", # The value of the header to add.

1160

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1161

# The default value is false.

1162

},

1163

],

1164

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

1169

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

1170

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1171

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

1172

"A String",

1173

],

1174

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

1175

},

1176

],

1177

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1178

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

1179

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

1180

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

1181

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

1182

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

1183

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1184

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

1185

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

1186

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

1187

# Default is false.

1188

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1189

"A String",

1190

],

1191

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1192

"A String",

1193

],

1194

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1195

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1196

"A String",

1197

],

1198

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1199

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1200

"A String",

1201

],

1202

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

1203

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1204

"A String",

1205

],

1206

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1207

},

1208

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

1209

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1210

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

1211

"httpStatus": 42, # The HTTP status code used to abort the request.

1212

# The value must be between 200 and 599 inclusive.

1213

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1214

# The value must be between 0.0 and 100.0 inclusive.

1215

},

1216

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

1217

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

1218

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1219

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1220

},

1221

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1222

# The value must be between 0.0 and 100.0 inclusive.

1223

},

1224

},

1225

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

1226

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1227

},

1228

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1229

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1230

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

1231

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

1232

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1233

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1234

},

1235

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1236

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

1237

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1238

# -

1239

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1240

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1241

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

1242

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1243

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1244

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1245

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

1250

# If not specified, will use the largest timeout among all backend services associated with the route.

1251

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1252

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1253

},

1254

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

1255

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

1256

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1257

# The value must be between 1 and 255 characters.

1258

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

1259

# The value must be between 1 and 1024 characters.

1260

},

1261

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

1262

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

1263

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

1264

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

1265

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1266

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1267

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1268

{ # Specification determining how headers are added to requests or responses.

1269

"headerName": "A String", # The name of the header.

1270

"headerValue": "A String", # The value of the header to add.

1271

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1272

# The default value is false.

1273

},

1274

],

1275

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1276

"A String",

1277

],

1278

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1279

{ # Specification determining how headers are added to requests or responses.

1280

"headerName": "A String", # The name of the header.

1281

"headerValue": "A String", # The value of the header to add.

1282

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1283

# The default value is false.

1284

},

1285

],

1286

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

1291

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

1292

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

1297

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

1298

# - compute/v1/projects/project/global/backendServices/backendService

1299

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

1300

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1301

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

1302

# - compute.backendBuckets.use

1303

# - compute.backendServices.use

1304

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1305

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1306

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1307

# The value must be between 1 and 255 characters.

1308

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

1309

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1310

# The default is set to false.

1311

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1312

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1313

# The value must be between 1 and 1024 characters.

1314

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1315

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1316

# The value must be between 1 and 1024 characters.

1317

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1318

# Supported values are:

1319

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1320

# - FOUND, which corresponds to 302.

1321

# - SEE_OTHER which corresponds to 303.

1322

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1323

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1324

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

1325

# The default is set to false.

1326

},

1327

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1328

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1329

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

1330

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1331

{ # Specification determining how headers are added to requests or responses.

1332

"headerName": "A String", # The name of the header.

1333

"headerValue": "A String", # The value of the header to add.

1334

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1335

# The default value is false.

1336

},

1337

],

1338

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1339

"A String",

1340

],

1341

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1342

{ # Specification determining how headers are added to requests or responses.

1343

"headerName": "A String", # The name of the header.

1344

"headerValue": "A String", # The value of the header to add.

1345

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1346

# The default value is false.

1347

},

1348

],

1349

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

1354

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

1355

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

1356

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1357

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1358

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

1359

"A String",

1360

],

1361

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

1362

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1363

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

1364

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

1365

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

1366

# Default is false.

1367

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1368

"A String",

1369

],

1370

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1371

"A String",

1372

],

1373

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1374

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1375

"A String",

1376

],

1377

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1378

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1379

"A String",

1380

],

1381

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

1382

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1383

"A String",

1384

],

1385

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1386

},

1387

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

1388

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1389

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

1390

"httpStatus": 42, # The HTTP status code used to abort the request.

1391

# The value must be between 200 and 599 inclusive.

1392

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1393

# The value must be between 0.0 and 100.0 inclusive.

1394

},

1395

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

1396

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

1397

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1398

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1399

},

1400

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1401

# The value must be between 0.0 and 100.0 inclusive.

1402

},

1403

},

1404

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

1405

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1406

},

1407

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1408

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1409

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

1410

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

1411

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1412

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1413

},

1414

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1415

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

1416

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1417

# -

1418

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1419

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1420

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

1421

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1422

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1423

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1424

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

1429

# If not specified, will use the largest timeout among all backend services associated with the route.

1430

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1431

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1432

},

1433

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

1434

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

1435

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1436

# The value must be between 1 and 255 characters.

1437

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

1438

# The value must be between 1 and 1024 characters.

1439

},

1440

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

1441

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

1442

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

1443

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

1444

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1445

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1446

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1447

{ # Specification determining how headers are added to requests or responses.

1448

"headerName": "A String", # The name of the header.

1449

"headerValue": "A String", # The value of the header to add.

1450

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1451

# The default value is false.

1452

},

1453

],

1454

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1455

"A String",

1456

],

1457

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1458

{ # Specification determining how headers are added to requests or responses.

1459

"headerName": "A String", # The name of the header.

1460

"headerValue": "A String", # The value of the header to add.

1461

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1462

# The default value is false.

1463

},

1464

],

1465

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

1470

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

1471

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

1476

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1477

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1478

# If urlRedirect is specified, service or routeAction must not be set.

1479

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1480

# The value must be between 1 and 255 characters.

1481

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

1482

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1483

# The default is set to false.

1484

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1485

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1486

# The value must be between 1 and 1024 characters.

1487

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1488

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1489

# The value must be between 1 and 1024 characters.

1490

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1491

# Supported values are:

1492

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1493

# - FOUND, which corresponds to 302.

1494

# - SEE_OTHER which corresponds to 303.

1495

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1496

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1497

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

1498

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

1503

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1504

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1505

"description": "A String", # The short description conveying the intent of this routeRule.

1506

# The description can have a maximum length of 1024 characters.

1507

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1508

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1509

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1510

{ # Specification determining how headers are added to requests or responses.

1511

"headerName": "A String", # The name of the header.

1512

"headerValue": "A String", # The value of the header to add.

1513

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1514

# The default value is false.

1515

},

1516

],

1517

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1518

"A String",

1519

],

1520

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1521

{ # Specification determining how headers are added to requests or responses.

1522

"headerName": "A String", # The name of the header.

1523

"headerValue": "A String", # The value of the header to add.

1524

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1525

# The default value is false.

1526

},

1527

],

1528

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1534

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

1535

# fullPathMatch must be between 1 and 1024 characters.

1536

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1537

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1538

{ # matchRule criteria for request header matches.

1539

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1540

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1541

"headerName": "A String", # The name of the HTTP header to match.

1542

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1543

# For matching a request's method, use the headerName ":method".

1544

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

1545

# The default setting is false.

1546

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1547

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1548

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

1549

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1550

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

1551

# For example for a range [-5, 0]

1552

# - -3 will match.

1553

# - 0 will not match.

1554

# - 0.25 will not match.

1555

# - -3someString will not match.

1556

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1557

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1558

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1559

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1560

},

1561

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

1562

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

1563

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1564

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1565

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1566

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1567

},

1568

],

1569

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1570

# The default value is false.

1571

# ignoreCase must not be used with regexMatch.

1572

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

1573

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

1574

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1575

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1576

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

1577

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

1578

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

1579

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1580

# This list must not be empty and can have at the most 64 entries.

1581

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1582

"name": "A String", # Name of metadata label.

1583

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1584

"value": "A String", # The value of the label must match the specified value.

1585

# value can have a maximum length of 1024 characters.

1586

},

1587

],

1588

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1589

# Supported values are:

1590

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1591

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1592

},

1593

],

1594

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1595

# The value must be between 1 and 1024 characters.

1596

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1597

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1598

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1599

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1600

# Only one of presentMatch, exactMatch or regexMatch must be set.

1601

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

1602

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

1603

# Only one of presentMatch, exactMatch or regexMatch must be set.

1604

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

1605

# Only one of presentMatch, exactMatch or regexMatch must be set.

1606

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1607

},

1608

],

1609

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1610

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1611

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1612

},

1613

],

1614

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

1615

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

1616

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

1617

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

1618

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1619

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

1620

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

1621

# Default is false.

1622

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1623

"A String",

1624

],

1625

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1626

"A String",

1627

],

1628

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1629

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1630

"A String",

1631

],

1632

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1633

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1634

"A String",

1635

],

1636

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

1637

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1638

"A String",

1639

],

1640

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1641

},

1642

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

1643

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1644

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

1645

"httpStatus": 42, # The HTTP status code used to abort the request.

1646

# The value must be between 200 and 599 inclusive.

1647

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1648

# The value must be between 0.0 and 100.0 inclusive.

1649

},

1650

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

1651

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

1652

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1653

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1654

},

1655

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1656

# The value must be between 0.0 and 100.0 inclusive.

1657

},

1658

},

1659

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

1660

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1661

},

1662

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1663

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1664

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

1665

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

1666

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1667

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1668

},

1669

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1670

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

1671

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1672

# -

1673

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1674

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1675

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

1676

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1677

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1678

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1679

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

1684

# If not specified, will use the largest timeout among all backend services associated with the route.

1685

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1686

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1687

},

1688

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

1689

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

1690

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1691

# The value must be between 1 and 255 characters.

1692

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

1693

# The value must be between 1 and 1024 characters.

1694

},

1695

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

1696

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

1697

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

1698

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

1699

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1700

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1701

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1702

{ # Specification determining how headers are added to requests or responses.

1703

"headerName": "A String", # The name of the header.

1704

"headerValue": "A String", # The value of the header to add.

1705

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1706

# The default value is false.

1707

},

1708

],

1709

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1710

"A String",

1711

],

1712

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1713

{ # Specification determining how headers are added to requests or responses.

1714

"headerName": "A String", # The name of the header.

1715

"headerValue": "A String", # The value of the header to add.

1716

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1717

# The default value is false.

1718

},

1719

],

1720

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

1725

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

1726

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

1731

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1732

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1733

# If urlRedirect is specified, service or routeAction must not be set.

1734

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1735

# The value must be between 1 and 255 characters.

1736

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

1737

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1738

# The default is set to false.

1739

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1740

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1741

# The value must be between 1 and 1024 characters.

1742

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1743

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

1744

# The value must be between 1 and 1024 characters.

1745

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1746

# Supported values are:

1747

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1748

# - FOUND, which corresponds to 302.

1749

# - SEE_OTHER which corresponds to 303.

1750

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1751

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1752

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

1753

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

1760

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1761

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

1762

{ # Message for the expected URL mappings.

1763

"description": "A String", # Description of this test case.

1764

"host": "A String", # Host portion of the URL.

1765

"path": "A String", # Path portion of the URL.

1766

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1767

},

1768

],

1769

}

Bu Sun Kim

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

[diff] [blame]

1770

1771

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

1772

1773

Returns:

1774

An object of the form:

1775

1776

{ # Represents an Operation resource.

1777

#

Dan O'Meara

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

[diff] [blame]

1778

# Google Compute Engine has three Operation resources:

1779

#

1780

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1781

#

Bu Sun Kim

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

[diff] [blame]

1782

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1783

#

1784

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1785

# - For global operations, use the `globalOperations` resource.

1786

# - For regional operations, use the `regionOperations` resource.

1787

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

1788

#

Dan O'Meara

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

[diff] [blame]

1789

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

1790

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1791

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1792

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1793

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1794

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1795

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

1796

{

Bu Sun Kim

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

[diff] [blame]

1797

"code": "A String", # [Output Only] The error type identifier for this error.

1798

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1799

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

1800

},

1801

],

1802

},

Bu Sun Kim

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

[diff] [blame]

1803

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1804

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1805

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1806

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1807

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1808

"name": "A String", # [Output Only] Name of the operation.

1809

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1810

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1811

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1812

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1813

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1814

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1815

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1816

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1817

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1818

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1819

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1820

{

1821

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1822

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1823

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1824

{

1825

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1826

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1827

},

1828

],

1829

"message": "A String", # [Output Only] A human-readable description of the warning code.

1830

},

1831

],

1832

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1837

<code class="details" id="invalidateCache">invalidateCache(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

1838

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

1839

1840

Args:

1841

project: string, Project ID for this request. (required)

1842

region: string, Name of the region scoping this request. (required)

1843

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

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

[diff] [blame]

1844

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1845

The object takes the form of:

1846

1847

{

Bu Sun Kim

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

[diff] [blame]

1848

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

1849

"path": "A String",

Bu Sun Kim

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

[diff] [blame]

1850

}

1851

1852

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

1853

1854

Returns:

1855

An object of the form:

1856

1857

{ # Represents an Operation resource.

1858

#

Dan O'Meara

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

[diff] [blame]

1859

# Google Compute Engine has three Operation resources:

1860

#

1861

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1862

#

Bu Sun Kim

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

[diff] [blame]

1863

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1864

#

1865

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1866

# - For global operations, use the `globalOperations` resource.

1867

# - For regional operations, use the `regionOperations` resource.

1868

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

1869

#

Dan O'Meara

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

[diff] [blame]

1870

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

1871

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1872

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1873

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1874

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1875

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1876

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

1877

{

Bu Sun Kim

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

[diff] [blame]

1878

"code": "A String", # [Output Only] The error type identifier for this error.

1879

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1880

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

1881

},

1882

],

1883

},

Bu Sun Kim

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

[diff] [blame]

1884

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1885

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

1886

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1887

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1888

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1889

"name": "A String", # [Output Only] Name of the operation.

1890

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1891

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

1892

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1893

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1894

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1895

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1896

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1897

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1898

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

1899

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1900

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1901

{

1902

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

1903

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1904

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1905

{

1906

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

1907

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1908

},

1909

],

1910

"message": "A String", # [Output Only] A human-readable description of the warning code.

1911

},

1912

],

1913

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1918

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Bu Sun Kim

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

[diff] [blame]

1919

<pre>Retrieves the list of UrlMap resources available to the specified project in the specified region.

1920

1921

Args:

1922

project: string, Project ID for this request. (required)

1923

region: string, Name of the region scoping this request. (required)

Dan O'Meara

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

[diff] [blame]

1924

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

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

[diff] [blame]

1925

Dan O'Meara

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

[diff] [blame]

1926

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

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

[diff] [blame]

1927

Dan O'Meara

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

[diff] [blame]

1928

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

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

[diff] [blame]

1929

Bu Sun Kim

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

[diff] [blame]

1930

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

1931

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

1932

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1933

1934

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

1935

1936

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1937

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Bu Sun Kim

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

[diff] [blame]

1938

1939

Returns:

1940

An object of the form:

1941

1942

{ # Contains a list of UrlMap resources.

Bu Sun Kim

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

[diff] [blame]

1943

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1944

"items": [ # A list of UrlMap resources.

Dan O'Meara

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

[diff] [blame]

1945

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1946

#

1947

# Google Compute Engine has two URL Map resources:

1948

#

1949

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1950

#

1951

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1952

#

1953

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1954

#

1955

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1956

#

1957

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

1958

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1959

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

1960

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1961

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

1962

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

1963

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

1964

# Default is false.

1965

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1966

"A String",

Bu Sun Kim

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

[diff] [blame]

1967

],

Bu Sun Kim

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

[diff] [blame]

1968

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1969

"A String",

1970

],

1971

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1972

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1973

"A String",

1974

],

1975

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1976

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1977

"A String",

1978

],

1979

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

1980

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1981

"A String",

1982

],

1983

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1984

},

1985

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

1986

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1987

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

1988

"httpStatus": 42, # The HTTP status code used to abort the request.

1989

# The value must be between 200 and 599 inclusive.

1990

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1991

# The value must be between 0.0 and 100.0 inclusive.

1992

},

1993

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

1994

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

1995

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1996

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1997

},

1998

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1999

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

2000

},

2001

},

Bu Sun Kim

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

[diff] [blame]

2002

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

2003

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2004

},

2005

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2006

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2007

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

2008

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

2009

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2010

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

2011

},

Bu Sun Kim

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

[diff] [blame]

2012

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2013

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

2014

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2015

# -

2016

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2017

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2018

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

2019

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2020

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2021

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2022

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2023

"A String",

Bu Sun Kim

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

[diff] [blame]

2024

],

2025

},

Bu Sun Kim

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

[diff] [blame]

2026

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

2027

# If not specified, will use the largest timeout among all backend services associated with the route.

2028

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2029

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2030

},

2031

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

2032

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

2033

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

2034

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

2035

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

2036

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

2037

},

Bu Sun Kim

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

[diff] [blame]

2038

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

2039

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

2040

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

2041

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

2042

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2043

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2044

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2045

{ # Specification determining how headers are added to requests or responses.

2046

"headerName": "A String", # The name of the header.

2047

"headerValue": "A String", # The value of the header to add.

2048

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2049

# The default value is false.

2050

},

2051

],

2052

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2053

"A String",

2054

],

2055

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2056

{ # Specification determining how headers are added to requests or responses.

2057

"headerName": "A String", # The name of the header.

2058

"headerValue": "A String", # The value of the header to add.

2059

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2060

# The default value is false.

2061

},

2062

],

2063

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2068

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

2069

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

2070

},

2071

],

Bu Sun Kim

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

[diff] [blame]

2072

},

Bu Sun Kim

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

[diff] [blame]

2073

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

2074

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2075

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2076

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2077

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2078

# The value must be between 1 and 255 characters.

2079

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

2080

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2081

# The default is set to false.

2082

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2083

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2084

# The value must be between 1 and 1024 characters.

2085

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2086

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2087

# The value must be between 1 and 1024 characters.

2088

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2089

# Supported values are:

2090

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2091

# - FOUND, which corresponds to 302.

2092

# - SEE_OTHER which corresponds to 303.

2093

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2094

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2095

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

2096

# The default is set to false.

2097

},

2098

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2099

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

2100

#

2101

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2102

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2103

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2104

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2105

{ # Specification determining how headers are added to requests or responses.

2106

"headerName": "A String", # The name of the header.

2107

"headerValue": "A String", # The value of the header to add.

2108

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2109

# The default value is false.

2110

},

2111

],

2112

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2113

"A String",

2114

],

2115

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2116

{ # Specification determining how headers are added to requests or responses.

2117

"headerName": "A String", # The name of the header.

2118

"headerValue": "A String", # The value of the header to add.

2119

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2120

# The default value is false.

2121

},

2122

],

2123

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

2128

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2129

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2130

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

2131

"A String",

2132

],

2133

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

2134

},

2135

],

2136

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2137

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2138

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2139

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2140

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

2141

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

2142

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

2143

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

2144

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

2145

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

2146

# Default is false.

2147

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2148

"A String",

2149

],

2150

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2151

"A String",

2152

],

2153

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2154

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2155

"A String",

2156

],

2157

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2158

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2159

"A String",

2160

],

2161

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

2162

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2163

"A String",

2164

],

2165

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2166

},

2167

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

2168

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2169

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

2170

"httpStatus": 42, # The HTTP status code used to abort the request.

2171

# The value must be between 200 and 599 inclusive.

2172

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2173

# The value must be between 0.0 and 100.0 inclusive.

2174

},

2175

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

2176

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

2177

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2178

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2179

},

2180

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2181

# The value must be between 0.0 and 100.0 inclusive.

2182

},

2183

},

2184

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

2185

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2186

},

2187

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2188

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2189

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

2190

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

2191

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2192

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2193

},

2194

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2195

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

2196

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2197

# -

2198

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2199

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2200

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

2201

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2202

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2203

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2204

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

2209

# If not specified, will use the largest timeout among all backend services associated with the route.

2210

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2211

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2212

},

2213

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

2214

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

2215

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2216

# The value must be between 1 and 255 characters.

2217

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

2218

# The value must be between 1 and 1024 characters.

2219

},

2220

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

2221

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

2222

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

2223

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

2224

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2225

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2226

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2227

{ # Specification determining how headers are added to requests or responses.

2228

"headerName": "A String", # The name of the header.

2229

"headerValue": "A String", # The value of the header to add.

2230

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2231

# The default value is false.

2232

},

2233

],

2234

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2235

"A String",

2236

],

2237

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2238

{ # Specification determining how headers are added to requests or responses.

2239

"headerName": "A String", # The name of the header.

2240

"headerValue": "A String", # The value of the header to add.

2241

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2242

# The default value is false.

2243

},

2244

],

2245

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2250

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

2251

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

2256

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2257

# - compute/v1/projects/project/global/backendServices/backendService

2258

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

2259

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2260

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2261

# - compute.backendBuckets.use

2262

# - compute.backendServices.use

2263

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2264

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2265

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2266

# The value must be between 1 and 255 characters.

2267

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

2268

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2269

# The default is set to false.

2270

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2271

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2272

# The value must be between 1 and 1024 characters.

2273

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2274

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2275

# The value must be between 1 and 1024 characters.

2276

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2277

# Supported values are:

2278

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2279

# - FOUND, which corresponds to 302.

2280

# - SEE_OTHER which corresponds to 303.

2281

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2282

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2283

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

2284

# The default is set to false.

2285

},

2286

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2287

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2288

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2289

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2290

{ # Specification determining how headers are added to requests or responses.

2291

"headerName": "A String", # The name of the header.

2292

"headerValue": "A String", # The value of the header to add.

2293

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2294

# The default value is false.

2295

},

2296

],

2297

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2298

"A String",

2299

],

2300

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2301

{ # Specification determining how headers are added to requests or responses.

2302

"headerName": "A String", # The name of the header.

2303

"headerValue": "A String", # The value of the header to add.

2304

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2305

# The default value is false.

2306

},

2307

],

2308

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

2313

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

2314

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

2315

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2316

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2317

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

2318

"A String",

2319

],

2320

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

2321

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

2322

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

2323

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

2324

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

2325

# Default is false.

2326

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2327

"A String",

2328

],

2329

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2330

"A String",

2331

],

2332

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2333

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2334

"A String",

2335

],

2336

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2337

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2338

"A String",

2339

],

2340

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

2341

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2342

"A String",

2343

],

2344

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2345

},

2346

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

2347

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2348

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

2349

"httpStatus": 42, # The HTTP status code used to abort the request.

2350

# The value must be between 200 and 599 inclusive.

2351

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2352

# The value must be between 0.0 and 100.0 inclusive.

2353

},

2354

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

2355

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

2356

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2357

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2358

},

2359

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2360

# The value must be between 0.0 and 100.0 inclusive.

2361

},

2362

},

2363

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

2364

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2365

},

2366

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2367

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2368

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

2369

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

2370

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2371

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2372

},

2373

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2374

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

2375

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2376

# -

2377

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2378

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2379

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

2380

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2381

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2382

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2383

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

2388

# If not specified, will use the largest timeout among all backend services associated with the route.

2389

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2390

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2391

},

2392

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

2393

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

2394

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2395

# The value must be between 1 and 255 characters.

2396

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

2397

# The value must be between 1 and 1024 characters.

2398

},

2399

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

2400

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

2401

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

2402

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

2403

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2404

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2405

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2406

{ # Specification determining how headers are added to requests or responses.

2407

"headerName": "A String", # The name of the header.

2408

"headerValue": "A String", # The value of the header to add.

2409

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2410

# The default value is false.

2411

},

2412

],

2413

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2414

"A String",

2415

],

2416

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2417

{ # Specification determining how headers are added to requests or responses.

2418

"headerName": "A String", # The name of the header.

2419

"headerValue": "A String", # The value of the header to add.

2420

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2421

# The default value is false.

2422

},

2423

],

2424

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2429

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

2430

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

2435

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2436

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2437

# If urlRedirect is specified, service or routeAction must not be set.

2438

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2439

# The value must be between 1 and 255 characters.

2440

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

2441

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2442

# The default is set to false.

2443

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2444

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2445

# The value must be between 1 and 1024 characters.

2446

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2447

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2448

# The value must be between 1 and 1024 characters.

2449

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2450

# Supported values are:

2451

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2452

# - FOUND, which corresponds to 302.

2453

# - SEE_OTHER which corresponds to 303.

2454

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2455

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2456

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

2457

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

2462

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2463

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2464

"description": "A String", # The short description conveying the intent of this routeRule.

2465

# The description can have a maximum length of 1024 characters.

2466

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2467

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2468

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2469

{ # Specification determining how headers are added to requests or responses.

2470

"headerName": "A String", # The name of the header.

2471

"headerValue": "A String", # The value of the header to add.

2472

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2473

# The default value is false.

2474

},

2475

],

2476

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2477

"A String",

2478

],

2479

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2480

{ # Specification determining how headers are added to requests or responses.

2481

"headerName": "A String", # The name of the header.

2482

"headerValue": "A String", # The value of the header to add.

2483

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2484

# The default value is false.

2485

},

2486

],

2487

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2493

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

2494

# fullPathMatch must be between 1 and 1024 characters.

2495

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2496

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2497

{ # matchRule criteria for request header matches.

2498

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2499

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2500

"headerName": "A String", # The name of the HTTP header to match.

2501

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2502

# For matching a request's method, use the headerName ":method".

2503

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

2504

# The default setting is false.

2505

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2506

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2507

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

2508

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2509

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

2510

# For example for a range [-5, 0]

2511

# - -3 will match.

2512

# - 0 will not match.

2513

# - 0.25 will not match.

2514

# - -3someString will not match.

2515

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2516

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2517

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2518

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2519

},

2520

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

2521

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

2522

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2523

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2524

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2525

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2526

},

2527

],

2528

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2529

# The default value is false.

2530

# ignoreCase must not be used with regexMatch.

2531

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

2532

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

2533

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2534

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2535

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

2536

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

2537

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

2538

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2539

# This list must not be empty and can have at the most 64 entries.

2540

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2541

"name": "A String", # Name of metadata label.

2542

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2543

"value": "A String", # The value of the label must match the specified value.

2544

# value can have a maximum length of 1024 characters.

2545

},

2546

],

2547

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2548

# Supported values are:

2549

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2550

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2551

},

2552

],

2553

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2554

# The value must be between 1 and 1024 characters.

2555

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2556

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2557

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2558

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2559

# Only one of presentMatch, exactMatch or regexMatch must be set.

2560

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

2561

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

2562

# Only one of presentMatch, exactMatch or regexMatch must be set.

2563

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

2564

# Only one of presentMatch, exactMatch or regexMatch must be set.

2565

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2566

},

2567

],

2568

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2569

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2570

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2571

},

2572

],

2573

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

2574

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

2575

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

2576

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

2577

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2578

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

2579

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

2580

# Default is false.

2581

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2582

"A String",

2583

],

2584

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2585

"A String",

2586

],

2587

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2588

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2589

"A String",

2590

],

2591

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2592

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2593

"A String",

2594

],

2595

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

2596

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2597

"A String",

2598

],

2599

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2600

},

2601

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

2602

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2603

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

2604

"httpStatus": 42, # The HTTP status code used to abort the request.

2605

# The value must be between 200 and 599 inclusive.

2606

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2607

# The value must be between 0.0 and 100.0 inclusive.

2608

},

2609

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

2610

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

2611

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2612

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2613

},

2614

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2615

# The value must be between 0.0 and 100.0 inclusive.

2616

},

2617

},

2618

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

2619

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2620

},

2621

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2622

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2623

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

2624

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

2625

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2626

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2627

},

2628

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2629

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

2630

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2631

# -

2632

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2633

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2634

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

2635

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2636

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2637

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2638

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

2643

# If not specified, will use the largest timeout among all backend services associated with the route.

2644

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2645

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2646

},

2647

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

2648

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

2649

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2650

# The value must be between 1 and 255 characters.

2651

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

2652

# The value must be between 1 and 1024 characters.

2653

},

2654

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

2655

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

2656

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

2657

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

2658

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2659

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2660

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2661

{ # Specification determining how headers are added to requests or responses.

2662

"headerName": "A String", # The name of the header.

2663

"headerValue": "A String", # The value of the header to add.

2664

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2665

# The default value is false.

2666

},

2667

],

2668

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2669

"A String",

2670

],

2671

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2672

{ # Specification determining how headers are added to requests or responses.

2673

"headerName": "A String", # The name of the header.

2674

"headerValue": "A String", # The value of the header to add.

2675

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2676

# The default value is false.

2677

},

2678

],

2679

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2684

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

2685

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

2690

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2691

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2692

# If urlRedirect is specified, service or routeAction must not be set.

2693

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2694

# The value must be between 1 and 255 characters.

2695

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

2696

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2697

# The default is set to false.

2698

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2699

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2700

# The value must be between 1 and 1024 characters.

2701

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2702

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2703

# The value must be between 1 and 1024 characters.

2704

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2705

# Supported values are:

2706

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2707

# - FOUND, which corresponds to 302.

2708

# - SEE_OTHER which corresponds to 303.

2709

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2710

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2711

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

2712

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

2719

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2720

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

2721

{ # Message for the expected URL mappings.

2722

"description": "A String", # Description of this test case.

2723

"host": "A String", # Host portion of the URL.

2724

"path": "A String", # Path portion of the URL.

2725

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2726

},

2727

],

2728

},

Bu Sun Kim

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

[diff] [blame]

2729

],

Bu Sun Kim

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

[diff] [blame]

2730

"kind": "compute#urlMapList", # Type of resource.

2731

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

2732

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2733

"warning": { # [Output Only] Informational warning message.

2734

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

2735

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2736

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

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

[diff] [blame]

2737

{

Bu Sun Kim

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

[diff] [blame]

2738

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

2739

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

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

[diff] [blame]

2740

},

2741

],

Bu Sun Kim

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

[diff] [blame]

2742

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

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

[diff] [blame]

2743

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2749

<pre>Retrieves the next page of results.

2750

2751

Args:

2752

previous_request: The request for the previous page. (required)

2753

previous_response: The response from the request for the previous page. (required)

2754

2755

Returns:

Bu Sun Kim

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

[diff] [blame]

2756

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

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

[diff] [blame]

2757

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

2762

<code class="details" id="patch">patch(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

2763

<pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

2764

2765

Args:

2766

project: string, Project ID for this request. (required)

2767

region: string, Name of the region scoping this request. (required)

2768

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

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

[diff] [blame]

2769

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

2770

The object takes the form of:

2771

Dan O'Meara

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

[diff] [blame]

2772

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

2773

#

2774

# Google Compute Engine has two URL Map resources:

2775

#

2776

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2777

#

2778

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2779

#

2780

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2781

#

2782

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2783

#

2784

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

2785

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2786

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

2787

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

2788

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

2789

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

2790

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

2791

# Default is false.

2792

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2793

"A String",

Bu Sun Kim

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

[diff] [blame]

2794

],

Bu Sun Kim

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

[diff] [blame]

2795

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2796

"A String",

2797

],

2798

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2799

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2800

"A String",

2801

],

2802

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2803

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2804

"A String",

2805

],

2806

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

2807

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2808

"A String",

2809

],

2810

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2811

},

2812

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

2813

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2814

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

2815

"httpStatus": 42, # The HTTP status code used to abort the request.

2816

# The value must be between 200 and 599 inclusive.

2817

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2818

# The value must be between 0.0 and 100.0 inclusive.

2819

},

2820

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

2821

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

2822

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2823

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2824

},

2825

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2826

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

2827

},

2828

},

Bu Sun Kim

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

[diff] [blame]

2829

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

2830

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2831

},

2832

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2833

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2834

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

2835

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

2836

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2837

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

2838

},

Bu Sun Kim

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

[diff] [blame]

2839

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2840

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

2841

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2842

# -

2843

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2844

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2845

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

2846

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2847

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2848

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2849

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2850

"A String",

Bu Sun Kim

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

[diff] [blame]

2851

],

2852

},

Bu Sun Kim

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

[diff] [blame]

2853

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

2854

# If not specified, will use the largest timeout among all backend services associated with the route.

2855

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2856

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2857

},

2858

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

2859

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

2860

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

2861

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

2862

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

2863

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

2864

},

Bu Sun Kim

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

[diff] [blame]

2865

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

2866

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

2867

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

2868

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

2869

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2870

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2871

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2872

{ # Specification determining how headers are added to requests or responses.

2873

"headerName": "A String", # The name of the header.

2874

"headerValue": "A String", # The value of the header to add.

2875

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2876

# The default value is false.

2877

},

2878

],

2879

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2880

"A String",

2881

],

2882

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2883

{ # Specification determining how headers are added to requests or responses.

2884

"headerName": "A String", # The name of the header.

2885

"headerValue": "A String", # The value of the header to add.

2886

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2887

# The default value is false.

2888

},

2889

],

2890

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2895

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

2896

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

2897

},

2898

],

Bu Sun Kim

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

[diff] [blame]

2899

},

2900

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

2901

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2902

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2903

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2904

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2905

# The value must be between 1 and 255 characters.

2906

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

2907

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2908

# The default is set to false.

2909

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2910

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2911

# The value must be between 1 and 1024 characters.

2912

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2913

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

2914

# The value must be between 1 and 1024 characters.

2915

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2916

# Supported values are:

2917

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2918

# - FOUND, which corresponds to 302.

2919

# - SEE_OTHER which corresponds to 303.

2920

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2921

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2922

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

2923

# The default is set to false.

2924

},

2925

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2926

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

2927

#

2928

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2929

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2930

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2931

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2932

{ # Specification determining how headers are added to requests or responses.

2933

"headerName": "A String", # The name of the header.

2934

"headerValue": "A String", # The value of the header to add.

2935

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2936

# The default value is false.

2937

},

2938

],

2939

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2940

"A String",

2941

],

2942

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2943

{ # Specification determining how headers are added to requests or responses.

2944

"headerName": "A String", # The name of the header.

2945

"headerValue": "A String", # The value of the header to add.

2946

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2947

# The default value is false.

2948

},

2949

],

2950

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

2955

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2956

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2957

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

2958

"A String",

2959

],

2960

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

2961

},

2962

],

2963

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2964

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2965

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

2966

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2967

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

2968

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

2969

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

2970

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

2971

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

2972

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

2973

# Default is false.

2974

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2975

"A String",

2976

],

2977

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2978

"A String",

2979

],

2980

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2981

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2982

"A String",

2983

],

2984

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2985

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2986

"A String",

2987

],

2988

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

2989

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2990

"A String",

2991

],

2992

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2993

},

2994

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

2995

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2996

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

2997

"httpStatus": 42, # The HTTP status code used to abort the request.

2998

# The value must be between 200 and 599 inclusive.

2999

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3000

# The value must be between 0.0 and 100.0 inclusive.

3001

},

3002

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

3003

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

3004

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3005

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3006

},

3007

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3008

# The value must be between 0.0 and 100.0 inclusive.

3009

},

3010

},

3011

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

3012

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3013

},

3014

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3015

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3016

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3017

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3018

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3019

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3020

},

3021

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3022

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3023

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3024

# -

3025

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3026

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3027

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3028

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3029

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3030

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3031

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3036

# If not specified, will use the largest timeout among all backend services associated with the route.

3037

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3038

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3039

},

3040

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

3041

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

3042

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3043

# The value must be between 1 and 255 characters.

3044

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3045

# The value must be between 1 and 1024 characters.

3046

},

3047

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3048

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3049

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3050

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3051

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3052

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3053

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3054

{ # Specification determining how headers are added to requests or responses.

3055

"headerName": "A String", # The name of the header.

3056

"headerValue": "A String", # The value of the header to add.

3057

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3058

# The default value is false.

3059

},

3060

],

3061

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3062

"A String",

3063

],

3064

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3065

{ # Specification determining how headers are added to requests or responses.

3066

"headerName": "A String", # The name of the header.

3067

"headerValue": "A String", # The value of the header to add.

3068

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3069

# The default value is false.

3070

},

3071

],

3072

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3077

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3078

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

3083

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3084

# - compute/v1/projects/project/global/backendServices/backendService

3085

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

3086

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3087

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3088

# - compute.backendBuckets.use

3089

# - compute.backendServices.use

3090

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3091

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3092

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3093

# The value must be between 1 and 255 characters.

3094

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3095

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3096

# The default is set to false.

3097

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3098

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3099

# The value must be between 1 and 1024 characters.

3100

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3101

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3102

# The value must be between 1 and 1024 characters.

3103

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3104

# Supported values are:

3105

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3106

# - FOUND, which corresponds to 302.

3107

# - SEE_OTHER which corresponds to 303.

3108

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3109

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3110

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3111

# The default is set to false.

3112

},

3113

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3114

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3115

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3116

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3117

{ # Specification determining how headers are added to requests or responses.

3118

"headerName": "A String", # The name of the header.

3119

"headerValue": "A String", # The value of the header to add.

3120

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3121

# The default value is false.

3122

},

3123

],

3124

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3125

"A String",

3126

],

3127

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3128

{ # Specification determining how headers are added to requests or responses.

3129

"headerName": "A String", # The name of the header.

3130

"headerValue": "A String", # The value of the header to add.

3131

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3132

# The default value is false.

3133

},

3134

],

3135

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

3140

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

3141

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

3142

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3143

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3144

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

3145

"A String",

3146

],

3147

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

3148

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

3149

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

3150

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

3151

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

3152

# Default is false.

3153

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3154

"A String",

3155

],

3156

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3157

"A String",

3158

],

3159

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3160

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3161

"A String",

3162

],

3163

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3164

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3165

"A String",

3166

],

3167

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3168

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3169

"A String",

3170

],

3171

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3172

},

3173

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

3174

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3175

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

3176

"httpStatus": 42, # The HTTP status code used to abort the request.

3177

# The value must be between 200 and 599 inclusive.

3178

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3179

# The value must be between 0.0 and 100.0 inclusive.

3180

},

3181

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

3182

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

3183

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3184

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3185

},

3186

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3187

# The value must be between 0.0 and 100.0 inclusive.

3188

},

3189

},

3190

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

3191

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3192

},

3193

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3194

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3195

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3196

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3197

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3198

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3199

},

3200

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3201

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3202

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3203

# -

3204

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3205

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3206

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3207

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3208

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3209

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3210

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3215

# If not specified, will use the largest timeout among all backend services associated with the route.

3216

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3217

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3218

},

3219

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

3220

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

3221

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3222

# The value must be between 1 and 255 characters.

3223

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3224

# The value must be between 1 and 1024 characters.

3225

},

3226

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3227

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3228

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3229

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3230

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3231

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3232

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3233

{ # Specification determining how headers are added to requests or responses.

3234

"headerName": "A String", # The name of the header.

3235

"headerValue": "A String", # The value of the header to add.

3236

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3237

# The default value is false.

3238

},

3239

],

3240

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3241

"A String",

3242

],

3243

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3244

{ # Specification determining how headers are added to requests or responses.

3245

"headerName": "A String", # The name of the header.

3246

"headerValue": "A String", # The value of the header to add.

3247

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3248

# The default value is false.

3249

},

3250

],

3251

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3256

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3257

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

3262

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3263

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3264

# If urlRedirect is specified, service or routeAction must not be set.

3265

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3266

# The value must be between 1 and 255 characters.

3267

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3268

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3269

# The default is set to false.

3270

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3271

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3272

# The value must be between 1 and 1024 characters.

3273

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3274

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3275

# The value must be between 1 and 1024 characters.

3276

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3277

# Supported values are:

3278

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3279

# - FOUND, which corresponds to 302.

3280

# - SEE_OTHER which corresponds to 303.

3281

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3282

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3283

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3284

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

3289

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3290

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3291

"description": "A String", # The short description conveying the intent of this routeRule.

3292

# The description can have a maximum length of 1024 characters.

3293

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3294

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3295

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3296

{ # Specification determining how headers are added to requests or responses.

3297

"headerName": "A String", # The name of the header.

3298

"headerValue": "A String", # The value of the header to add.

3299

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3300

# The default value is false.

3301

},

3302

],

3303

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3304

"A String",

3305

],

3306

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3307

{ # Specification determining how headers are added to requests or responses.

3308

"headerName": "A String", # The name of the header.

3309

"headerValue": "A String", # The value of the header to add.

3310

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3311

# The default value is false.

3312

},

3313

],

3314

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3320

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

3321

# fullPathMatch must be between 1 and 1024 characters.

3322

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3323

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3324

{ # matchRule criteria for request header matches.

3325

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3326

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3327

"headerName": "A String", # The name of the HTTP header to match.

3328

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3329

# For matching a request's method, use the headerName ":method".

3330

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

3331

# The default setting is false.

3332

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3333

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3334

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

3335

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3336

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

3337

# For example for a range [-5, 0]

3338

# - -3 will match.

3339

# - 0 will not match.

3340

# - 0.25 will not match.

3341

# - -3someString will not match.

3342

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3343

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3344

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3345

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3346

},

3347

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

3348

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

3349

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3350

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3351

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3352

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3353

},

3354

],

3355

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3356

# The default value is false.

3357

# ignoreCase must not be used with regexMatch.

3358

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

3359

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

3360

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3361

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3362

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

3363

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

3364

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

3365

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3366

# This list must not be empty and can have at the most 64 entries.

3367

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3368

"name": "A String", # Name of metadata label.

3369

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3370

"value": "A String", # The value of the label must match the specified value.

3371

# value can have a maximum length of 1024 characters.

3372

},

3373

],

3374

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3375

# Supported values are:

3376

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3377

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3378

},

3379

],

3380

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3381

# The value must be between 1 and 1024 characters.

3382

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3383

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3384

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3385

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3386

# Only one of presentMatch, exactMatch or regexMatch must be set.

3387

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

3388

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

3389

# Only one of presentMatch, exactMatch or regexMatch must be set.

3390

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

3391

# Only one of presentMatch, exactMatch or regexMatch must be set.

3392

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3393

},

3394

],

3395

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3396

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3397

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3398

},

3399

],

3400

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

3401

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

3402

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

3403

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

3404

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3405

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

3406

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

3407

# Default is false.

3408

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3409

"A String",

3410

],

3411

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3412

"A String",

3413

],

3414

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3415

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3416

"A String",

3417

],

3418

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3419

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3420

"A String",

3421

],

3422

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3423

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3424

"A String",

3425

],

3426

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3427

},

3428

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

3429

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3430

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

3431

"httpStatus": 42, # The HTTP status code used to abort the request.

3432

# The value must be between 200 and 599 inclusive.

3433

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3434

# The value must be between 0.0 and 100.0 inclusive.

3435

},

3436

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

3437

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

3438

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3439

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3440

},

3441

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3442

# The value must be between 0.0 and 100.0 inclusive.

3443

},

3444

},

3445

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

3446

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3447

},

3448

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3449

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3450

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3451

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3452

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3453

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3454

},

3455

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3456

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3457

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3458

# -

3459

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3460

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3461

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3462

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3463

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3464

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3465

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3470

# If not specified, will use the largest timeout among all backend services associated with the route.

3471

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3472

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3473

},

3474

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

3475

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

3476

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3477

# The value must be between 1 and 255 characters.

3478

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3479

# The value must be between 1 and 1024 characters.

3480

},

3481

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3482

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3483

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3484

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3485

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3486

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3487

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3488

{ # Specification determining how headers are added to requests or responses.

3489

"headerName": "A String", # The name of the header.

3490

"headerValue": "A String", # The value of the header to add.

3491

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3492

# The default value is false.

3493

},

3494

],

3495

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3496

"A String",

3497

],

3498

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3499

{ # Specification determining how headers are added to requests or responses.

3500

"headerName": "A String", # The name of the header.

3501

"headerValue": "A String", # The value of the header to add.

3502

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3503

# The default value is false.

3504

},

3505

],

3506

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3511

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3512

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

3517

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3518

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3519

# If urlRedirect is specified, service or routeAction must not be set.

3520

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3521

# The value must be between 1 and 255 characters.

3522

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3523

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3524

# The default is set to false.

3525

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3526

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3527

# The value must be between 1 and 1024 characters.

3528

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3529

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3530

# The value must be between 1 and 1024 characters.

3531

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3532

# Supported values are:

3533

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3534

# - FOUND, which corresponds to 302.

3535

# - SEE_OTHER which corresponds to 303.

3536

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3537

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3538

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3539

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

3546

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3547

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

3548

{ # Message for the expected URL mappings.

3549

"description": "A String", # Description of this test case.

3550

"host": "A String", # Host portion of the URL.

3551

"path": "A String", # Path portion of the URL.

3552

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3553

},

3554

],

3555

}

Bu Sun Kim

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

[diff] [blame]

3556

3557

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

3558

3559

Returns:

3560

An object of the form:

3561

3562

{ # Represents an Operation resource.

3563

#

Dan O'Meara

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

[diff] [blame]

3564

# Google Compute Engine has three Operation resources:

3565

#

3566

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3567

#

Bu Sun Kim

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

[diff] [blame]

3568

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3569

#

3570

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

3571

# - For global operations, use the `globalOperations` resource.

3572

# - For regional operations, use the `regionOperations` resource.

3573

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

3574

#

Dan O'Meara

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

[diff] [blame]

3575

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

3576

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3577

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3578

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3579

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3580

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3581

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

3582

{

Bu Sun Kim

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

[diff] [blame]

3583

"code": "A String", # [Output Only] The error type identifier for this error.

3584

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3585

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

3586

},

3587

],

3588

},

Bu Sun Kim

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

[diff] [blame]

3589

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3590

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

3591

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3592

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3593

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3594

"name": "A String", # [Output Only] Name of the operation.

3595

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3596

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

3597

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3598

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3599

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3600

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3601

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3602

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3603

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

3604

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3605

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3606

{

3607

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

3608

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3609

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3610

{

3611

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

3612

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3613

},

3614

],

3615

"message": "A String", # [Output Only] A human-readable description of the warning code.

3616

},

3617

],

3618

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

3623

<code class="details" id="update">update(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

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

[diff] [blame]

3624

<pre>Updates the specified UrlMap resource with the data included in the request.

3625

3626

Args:

3627

project: string, Project ID for this request. (required)

3628

region: string, Name of the region scoping this request. (required)

3629

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

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

[diff] [blame]

3630

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

3631

The object takes the form of:

3632

Dan O'Meara

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

[diff] [blame]

3633

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

3634

#

3635

# Google Compute Engine has two URL Map resources:

3636

#

3637

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3638

#

3639

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3640

#

3641

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3642

#

3643

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3644

#

3645

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

3646

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3647

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

3648

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

3649

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

3650

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

3651

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

3652

# Default is false.

3653

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3654

"A String",

Bu Sun Kim

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

[diff] [blame]

3655

],

Bu Sun Kim

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

[diff] [blame]

3656

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3657

"A String",

3658

],

3659

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3660

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3661

"A String",

3662

],

3663

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3664

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3665

"A String",

3666

],

3667

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3668

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3669

"A String",

3670

],

3671

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3672

},

3673

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

3674

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3675

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

3676

"httpStatus": 42, # The HTTP status code used to abort the request.

3677

# The value must be between 200 and 599 inclusive.

3678

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3679

# The value must be between 0.0 and 100.0 inclusive.

3680

},

3681

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

3682

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

3683

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3684

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3685

},

3686

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3687

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

3688

},

3689

},

Bu Sun Kim

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

[diff] [blame]

3690

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

3691

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3692

},

3693

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3694

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3695

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3696

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3697

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3698

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

3699

},

Bu Sun Kim

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

[diff] [blame]

3700

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3701

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3702

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3703

# -

3704

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3705

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3706

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3707

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3708

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3709

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3710

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3711

"A String",

Bu Sun Kim

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

[diff] [blame]

3712

],

3713

},

Bu Sun Kim

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

[diff] [blame]

3714

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3715

# If not specified, will use the largest timeout among all backend services associated with the route.

3716

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3717

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3718

},

3719

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

3720

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

3721

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

3722

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

3723

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3724

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

3725

},

Bu Sun Kim

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

[diff] [blame]

3726

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3727

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3728

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3729

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3730

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3731

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3732

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3733

{ # Specification determining how headers are added to requests or responses.

3734

"headerName": "A String", # The name of the header.

3735

"headerValue": "A String", # The value of the header to add.

3736

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3737

# The default value is false.

3738

},

3739

],

3740

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3741

"A String",

3742

],

3743

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3744

{ # Specification determining how headers are added to requests or responses.

3745

"headerName": "A String", # The name of the header.

3746

"headerValue": "A String", # The value of the header to add.

3747

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3748

# The default value is false.

3749

},

3750

],

3751

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3756

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3757

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

3758

},

3759

],

Bu Sun Kim

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

[diff] [blame]

3760

},

3761

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

3762

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3763

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3764

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3765

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3766

# The value must be between 1 and 255 characters.

3767

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3768

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3769

# The default is set to false.

3770

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3771

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3772

# The value must be between 1 and 1024 characters.

3773

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3774

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3775

# The value must be between 1 and 1024 characters.

3776

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3777

# Supported values are:

3778

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3779

# - FOUND, which corresponds to 302.

3780

# - SEE_OTHER which corresponds to 303.

3781

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3782

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3783

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3784

# The default is set to false.

3785

},

3786

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3787

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

3788

#

3789

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3790

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3791

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3792

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3793

{ # Specification determining how headers are added to requests or responses.

3794

"headerName": "A String", # The name of the header.

3795

"headerValue": "A String", # The value of the header to add.

3796

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3797

# The default value is false.

3798

},

3799

],

3800

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3801

"A String",

3802

],

3803

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3804

{ # Specification determining how headers are added to requests or responses.

3805

"headerName": "A String", # The name of the header.

3806

"headerValue": "A String", # The value of the header to add.

3807

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3808

# The default value is false.

3809

},

3810

],

3811

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

3816

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3817

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3818

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

3819

"A String",

3820

],

3821

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

3822

},

3823

],

3824

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3825

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3826

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

3827

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3828

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

3829

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

3830

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

3831

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

3832

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

3833

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

3834

# Default is false.

3835

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3836

"A String",

3837

],

3838

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3839

"A String",

3840

],

3841

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3842

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3843

"A String",

3844

],

3845

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3846

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3847

"A String",

3848

],

3849

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3850

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3851

"A String",

3852

],

3853

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3854

},

3855

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

3856

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3857

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

3858

"httpStatus": 42, # The HTTP status code used to abort the request.

3859

# The value must be between 200 and 599 inclusive.

3860

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3861

# The value must be between 0.0 and 100.0 inclusive.

3862

},

3863

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

3864

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

3865

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3866

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3867

},

3868

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3869

# The value must be between 0.0 and 100.0 inclusive.

3870

},

3871

},

3872

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

3873

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3874

},

3875

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3876

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3877

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3878

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3879

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3880

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3881

},

3882

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3883

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3884

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3885

# -

3886

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3887

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3888

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3889

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3890

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3891

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3892

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3897

# If not specified, will use the largest timeout among all backend services associated with the route.

3898

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3899

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3900

},

3901

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

3902

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

3903

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3904

# The value must be between 1 and 255 characters.

3905

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3906

# The value must be between 1 and 1024 characters.

3907

},

3908

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3909

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3910

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3911

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3912

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3913

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3914

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3915

{ # Specification determining how headers are added to requests or responses.

3916

"headerName": "A String", # The name of the header.

3917

"headerValue": "A String", # The value of the header to add.

3918

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3919

# The default value is false.

3920

},

3921

],

3922

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3923

"A String",

3924

],

3925

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3926

{ # Specification determining how headers are added to requests or responses.

3927

"headerName": "A String", # The name of the header.

3928

"headerValue": "A String", # The value of the header to add.

3929

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3930

# The default value is false.

3931

},

3932

],

3933

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3938

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3939

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

3944

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3945

# - compute/v1/projects/project/global/backendServices/backendService

3946

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

3947

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3948

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3949

# - compute.backendBuckets.use

3950

# - compute.backendServices.use

3951

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3952

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3953

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3954

# The value must be between 1 and 255 characters.

3955

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3956

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3957

# The default is set to false.

3958

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3959

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3960

# The value must be between 1 and 1024 characters.

3961

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3962

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3963

# The value must be between 1 and 1024 characters.

3964

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3965

# Supported values are:

3966

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3967

# - FOUND, which corresponds to 302.

3968

# - SEE_OTHER which corresponds to 303.

3969

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3970

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3971

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3972

# The default is set to false.

3973

},

3974

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3975

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3976

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3977

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3978

{ # Specification determining how headers are added to requests or responses.

3979

"headerName": "A String", # The name of the header.

3980

"headerValue": "A String", # The value of the header to add.

3981

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3982

# The default value is false.

3983

},

3984

],

3985

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3986

"A String",

3987

],

3988

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3989

{ # Specification determining how headers are added to requests or responses.

3990

"headerName": "A String", # The name of the header.

3991

"headerValue": "A String", # The value of the header to add.

3992

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3993

# The default value is false.

3994

},

3995

],

3996

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

4001

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

4002

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

4003

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4004

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4005

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

4006

"A String",

4007

],

4008

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

4009

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

4010

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

4011

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

4012

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

4013

# Default is false.

4014

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4015

"A String",

4016

],

4017

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4018

"A String",

4019

],

4020

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4021

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4022

"A String",

4023

],

4024

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4025

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4026

"A String",

4027

],

4028

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

4029

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4030

"A String",

4031

],

4032

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4033

},

4034

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

4035

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4036

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4037

"httpStatus": 42, # The HTTP status code used to abort the request.

4038

# The value must be between 200 and 599 inclusive.

4039

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4040

# The value must be between 0.0 and 100.0 inclusive.

4041

},

4042

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4043

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4044

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4045

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4046

},

4047

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4048

# The value must be between 0.0 and 100.0 inclusive.

4049

},

4050

},

4051

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

4052

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4053

},

4054

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4055

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4056

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

4057

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

4058

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4059

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4060

},

4061

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4062

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

4063

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4064

# -

4065

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4066

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4067

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

4068

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4069

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4070

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4071

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

4076

# If not specified, will use the largest timeout among all backend services associated with the route.

4077

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4078

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4079

},

4080

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

4081

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

4082

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4083

# The value must be between 1 and 255 characters.

4084

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

4085

# The value must be between 1 and 1024 characters.

4086

},

4087

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

4088

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

4089

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

4090

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

4091

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4092

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4093

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4094

{ # Specification determining how headers are added to requests or responses.

4095

"headerName": "A String", # The name of the header.

4096

"headerValue": "A String", # The value of the header to add.

4097

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4098

# The default value is false.

4099

},

4100

],

4101

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4102

"A String",

4103

],

4104

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4105

{ # Specification determining how headers are added to requests or responses.

4106

"headerName": "A String", # The name of the header.

4107

"headerValue": "A String", # The value of the header to add.

4108

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4109

# The default value is false.

4110

},

4111

],

4112

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

4117

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

4118

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

4123

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4124

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4125

# If urlRedirect is specified, service or routeAction must not be set.

4126

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4127

# The value must be between 1 and 255 characters.

4128

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

4129

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4130

# The default is set to false.

4131

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4132

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4133

# The value must be between 1 and 1024 characters.

4134

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4135

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4136

# The value must be between 1 and 1024 characters.

4137

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4138

# Supported values are:

4139

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4140

# - FOUND, which corresponds to 302.

4141

# - SEE_OTHER which corresponds to 303.

4142

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4143

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4144

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

4145

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

4150

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4151

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4152

"description": "A String", # The short description conveying the intent of this routeRule.

4153

# The description can have a maximum length of 1024 characters.

4154

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4155

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4156

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4157

{ # Specification determining how headers are added to requests or responses.

4158

"headerName": "A String", # The name of the header.

4159

"headerValue": "A String", # The value of the header to add.

4160

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4161

# The default value is false.

4162

},

4163

],

4164

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4165

"A String",

4166

],

4167

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4168

{ # Specification determining how headers are added to requests or responses.

4169

"headerName": "A String", # The name of the header.

4170

"headerValue": "A String", # The value of the header to add.

4171

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4172

# The default value is false.

4173

},

4174

],

4175

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4181

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

4182

# fullPathMatch must be between 1 and 1024 characters.

4183

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4184

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4185

{ # matchRule criteria for request header matches.

4186

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4187

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4188

"headerName": "A String", # The name of the HTTP header to match.

4189

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4190

# For matching a request's method, use the headerName ":method".

4191

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

4192

# The default setting is false.

4193

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4194

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4195

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

4196

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4197

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

4198

# For example for a range [-5, 0]

4199

# - -3 will match.

4200

# - 0 will not match.

4201

# - 0.25 will not match.

4202

# - -3someString will not match.

4203

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4204

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4205

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4206

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4207

},

4208

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

4209

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

4210

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4211

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4212

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4213

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4214

},

4215

],

4216

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4217

# The default value is false.

4218

# ignoreCase must not be used with regexMatch.

4219

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

4220

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

4221

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4222

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4223

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

4224

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

4225

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

4226

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4227

# This list must not be empty and can have at the most 64 entries.

4228

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4229

"name": "A String", # Name of metadata label.

4230

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4231

"value": "A String", # The value of the label must match the specified value.

4232

# value can have a maximum length of 1024 characters.

4233

},

4234

],

4235

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4236

# Supported values are:

4237

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4238

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4239

},

4240

],

4241

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4242

# The value must be between 1 and 1024 characters.

4243

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4244

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4245

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4246

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4247

# Only one of presentMatch, exactMatch or regexMatch must be set.

4248

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

4249

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

4250

# Only one of presentMatch, exactMatch or regexMatch must be set.

4251

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

4252

# Only one of presentMatch, exactMatch or regexMatch must be set.

4253

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4254

},

4255

],

4256

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4257

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4258

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4259

},

4260

],

4261

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

4262

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

4263

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

4264

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

4265

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4266

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

4267

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

4268

# Default is false.

4269

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4270

"A String",

4271

],

4272

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4273

"A String",

4274

],

4275

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4276

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4277

"A String",

4278

],

4279

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4280

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4281

"A String",

4282

],

4283

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

4284

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4285

"A String",

4286

],

4287

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4288

},

4289

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

4290

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4291

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4292

"httpStatus": 42, # The HTTP status code used to abort the request.

4293

# The value must be between 200 and 599 inclusive.

4294

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4295

# The value must be between 0.0 and 100.0 inclusive.

4296

},

4297

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4298

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4299

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4300

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4301

},

4302

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4303

# The value must be between 0.0 and 100.0 inclusive.

4304

},

4305

},

4306

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

4307

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4308

},

4309

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4310

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4311

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

4312

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

4313

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4314

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4315

},

4316

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4317

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

4318

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4319

# -

4320

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4321

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4322

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

4323

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4324

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4325

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4326

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

4331

# If not specified, will use the largest timeout among all backend services associated with the route.

4332

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4333

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4334

},

4335

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

4336

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

4337

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4338

# The value must be between 1 and 255 characters.

4339

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

4340

# The value must be between 1 and 1024 characters.

4341

},

4342

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

4343

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

4344

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

4345

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

4346

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4347

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4348

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4349

{ # Specification determining how headers are added to requests or responses.

4350

"headerName": "A String", # The name of the header.

4351

"headerValue": "A String", # The value of the header to add.

4352

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4353

# The default value is false.

4354

},

4355

],

4356

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4357

"A String",

4358

],

4359

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4360

{ # Specification determining how headers are added to requests or responses.

4361

"headerName": "A String", # The name of the header.

4362

"headerValue": "A String", # The value of the header to add.

4363

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4364

# The default value is false.

4365

},

4366

],

4367

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

4372

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

4373

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

4378

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4379

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4380

# If urlRedirect is specified, service or routeAction must not be set.

4381

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4382

# The value must be between 1 and 255 characters.

4383

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

4384

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4385

# The default is set to false.

4386

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4387

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4388

# The value must be between 1 and 1024 characters.

4389

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4390

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4391

# The value must be between 1 and 1024 characters.

4392

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4393

# Supported values are:

4394

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4395

# - FOUND, which corresponds to 302.

4396

# - SEE_OTHER which corresponds to 303.

4397

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4398

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4399

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

4400

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

4407

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4408

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

4409

{ # Message for the expected URL mappings.

4410

"description": "A String", # Description of this test case.

4411

"host": "A String", # Host portion of the URL.

4412

"path": "A String", # Path portion of the URL.

4413

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4414

},

4415

],

4416

}

Bu Sun Kim

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

[diff] [blame]

4417

4418

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

4419

4420

Returns:

4421

An object of the form:

4422

4423

{ # Represents an Operation resource.

4424

#

Dan O'Meara

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

[diff] [blame]

4425

# Google Compute Engine has three Operation resources:

4426

#

4427

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4428

#

Bu Sun Kim

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

[diff] [blame]

4429

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4430

#

4431

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

4432

# - For global operations, use the `globalOperations` resource.

4433

# - For regional operations, use the `regionOperations` resource.

4434

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

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

[diff] [blame]

4435

#

Dan O'Meara

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

[diff] [blame]

4436

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

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

[diff] [blame]

4437

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4438

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4439

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4440

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4441

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4442

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

4443

{

Bu Sun Kim

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

[diff] [blame]

4444

"code": "A String", # [Output Only] The error type identifier for this error.

4445

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4446

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

4447

},

4448

],

4449

},

Bu Sun Kim

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

[diff] [blame]

4450

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4451

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

4452

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4453

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4454

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4455

"name": "A String", # [Output Only] Name of the operation.

4456

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4457

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

4458

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4459

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4460

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4461

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4462

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4463

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4464

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

4465

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4466

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4467

{

4468

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

4469

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4470

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4471

{

4472

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

4473

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4474

},

4475

],

4476

"message": "A String", # [Output Only] A human-readable description of the warning code.

4477

},

4478

],

4479

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

4484

<code class="details" id="validate">validate(project, region, urlMap, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

4485

<pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

4486

4487

Args:

4488

project: string, Project ID for this request. (required)

4489

region: string, Name of the region scoping this request. (required)

4490

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

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

[diff] [blame]

4491

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

4492

The object takes the form of:

4493

4494

{

Bu Sun Kim

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

[diff] [blame]

4495

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

4496

#

4497

# Google Compute Engine has two URL Map resources:

4498

#

4499

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4500

#

4501

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4502

#

4503

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4504

#

4505

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4506

#

4507

# To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

4508

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4509

"defaultRouteAction": { # defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

4510

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

4511

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

4512

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

4513

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

4514

# Default is false.

4515

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4516

"A String",

Bu Sun Kim

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

[diff] [blame]

4517

],

Bu Sun Kim

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

[diff] [blame]

4518

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4519

"A String",

4520

],

4521

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4522

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4523

"A String",

4524

],

4525

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4526

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4527

"A String",

4528

],

4529

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

4530

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4531

"A String",

4532

],

4533

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4534

},

4535

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

4536

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4537

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4538

"httpStatus": 42, # The HTTP status code used to abort the request.

4539

# The value must be between 200 and 599 inclusive.

4540

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4541

# The value must be between 0.0 and 100.0 inclusive.

4542

},

4543

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4544

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4545

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4546

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4547

},

4548

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4549

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

4550

},

4551

},

Bu Sun Kim

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

[diff] [blame]

4552

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

4553

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4554

},

4555

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4556

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4557

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

4558

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

4559

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4560

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

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

[diff] [blame]

4561

},

Bu Sun Kim

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

[diff] [blame]

4562

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4563

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

4564

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4565

# -

4566

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4567

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4568

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

4569

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4570

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4571

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4572

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4573

"A String",

Bu Sun Kim

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

[diff] [blame]

4574

],

4575

},

Bu Sun Kim

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

[diff] [blame]

4576

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

4577

# If not specified, will use the largest timeout among all backend services associated with the route.

4578

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4579

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4580

},

4581

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

4582

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

4583

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

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

[diff] [blame]

4584

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

4585

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

4586

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

4587

},

Bu Sun Kim

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

[diff] [blame]

4588

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

4589

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

4590

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

4591

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

4592

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4593

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4594

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4595

{ # Specification determining how headers are added to requests or responses.

4596

"headerName": "A String", # The name of the header.

4597

"headerValue": "A String", # The value of the header to add.

4598

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4599

# The default value is false.

4600

},

4601

],

4602

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4603

"A String",

4604

],

4605

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4606

{ # Specification determining how headers are added to requests or responses.

4607

"headerName": "A String", # The name of the header.

4608

"headerValue": "A String", # The value of the header to add.

4609

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4610

# The default value is false.

4611

},

4612

],

4613

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

4618

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

4619

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

4620

},

4621

],

Bu Sun Kim

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

[diff] [blame]

4622

},

Bu Sun Kim

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

[diff] [blame]

4623

"defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

4624

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4625

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4626

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4627

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4628

# The value must be between 1 and 255 characters.

4629

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

4630

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4631

# The default is set to false.

4632

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4633

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4634

# The value must be between 1 and 1024 characters.

4635

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4636

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4637

# The value must be between 1 and 1024 characters.

4638

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4639

# Supported values are:

4640

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4641

# - FOUND, which corresponds to 302.

4642

# - SEE_OTHER which corresponds to 303.

4643

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4644

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4645

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

4646

# The default is set to false.

4647

},

4648

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4649

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.

4650

#

4651

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4652

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4653

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4654

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4655

{ # Specification determining how headers are added to requests or responses.

4656

"headerName": "A String", # The name of the header.

4657

"headerValue": "A String", # The value of the header to add.

4658

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4659

# The default value is false.

4660

},

4661

],

4662

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4663

"A String",

4664

],

4665

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4666

{ # Specification determining how headers are added to requests or responses.

4667

"headerName": "A String", # The name of the header.

4668

"headerValue": "A String", # The value of the header to add.

4669

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4670

# The default value is false.

4671

},

4672

],

4673

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

4678

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4679

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4680

"hosts": [ # The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

4681

"A String",

4682

],

4683

"pathMatcher": "A String", # The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

4684

},

4685

],

4686

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4687

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4688

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

4689

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4690

{ # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.

4691

"defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.

4692

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

4693

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

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

[diff] [blame]

4694

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

4695

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

4696

# Default is false.

4697

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4698

"A String",

4699

],

4700

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4701

"A String",

4702

],

4703

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4704

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4705

"A String",

4706

],

4707

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4708

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4709

"A String",

4710

],

4711

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

4712

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4713

"A String",

4714

],

4715

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4716

},

4717

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

4718

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4719

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4720

"httpStatus": 42, # The HTTP status code used to abort the request.

4721

# The value must be between 200 and 599 inclusive.

4722

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4723

# The value must be between 0.0 and 100.0 inclusive.

4724

},

4725

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4726

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4727

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4728

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4729

},

4730

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4731

# The value must be between 0.0 and 100.0 inclusive.

4732

},

4733

},

4734

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

4735

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4736

},

4737

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4738

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4739

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

4740

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

4741

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4742

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4743

},

4744

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4745

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

4746

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4747

# -

4748

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4749

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4750

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

4751

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4752

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4753

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4754

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

4759

# If not specified, will use the largest timeout among all backend services associated with the route.

4760

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4761

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4762

},

4763

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

4764

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

4765

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4766

# The value must be between 1 and 255 characters.

4767

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

4768

# The value must be between 1 and 1024 characters.

4769

},

4770

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

4771

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

4772

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

4773

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

4774

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4775

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4776

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4777

{ # Specification determining how headers are added to requests or responses.

4778

"headerName": "A String", # The name of the header.

4779

"headerValue": "A String", # The value of the header to add.

4780

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4781

# The default value is false.

4782

},

4783

],

4784

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4785

"A String",

4786

],

4787

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4788

{ # Specification determining how headers are added to requests or responses.

4789

"headerName": "A String", # The name of the header.

4790

"headerValue": "A String", # The value of the header to add.

4791

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4792

# The default value is false.

4793

},

4794

],

4795

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

4800

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

4801

# The value must be between 0 and 1000

},

],

},

"defaultService": "A String", # The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

4806

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4807

# - compute/v1/projects/project/global/backendServices/backendService

4808

# - global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.

4809

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4810

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4811

# - compute.backendBuckets.use

4812

# - compute.backendServices.use

4813

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4814

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4815

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4816

# The value must be between 1 and 255 characters.

4817

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

4818

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4819

# The default is set to false.

4820

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4821

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4822

# The value must be between 1 and 1024 characters.

4823

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4824

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4825

# The value must be between 1 and 1024 characters.

4826

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4827

# Supported values are:

4828

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4829

# - FOUND, which corresponds to 302.

4830

# - SEE_OTHER which corresponds to 303.

4831

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4832

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4833

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

4834

# The default is set to false.

4835

},

4836

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4837

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4838

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4839

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4840

{ # Specification determining how headers are added to requests or responses.

4841

"headerName": "A String", # The name of the header.

4842

"headerValue": "A String", # The value of the header to add.

4843

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4844

# The default value is false.

4845

},

4846

],

4847

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4848

"A String",

4849

],

4850

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4851

{ # Specification determining how headers are added to requests or responses.

4852

"headerName": "A String", # The name of the header.

4853

"headerValue": "A String", # The value of the header to add.

4854

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4855

# The default value is false.

4856

},

4857

],

4858

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"name": "A String", # The name to which this PathMatcher is referred by the HostRule.

4863

"pathRules": [ # The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.

4864

# For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.

4865

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4866

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4867

"paths": [ # The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

4868

"A String",

4869

],

4870

"routeAction": { # In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

4871

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

4872

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

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

[diff] [blame]

4873

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

4874

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

4875

# Default is false.

4876

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4877

"A String",

4878

],

4879

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4880

"A String",

4881

],

4882

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4883

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4884

"A String",

4885

],

4886

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4887

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4888

"A String",

4889

],

4890

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

4891

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4892

"A String",

4893

],

4894

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4895

},

4896

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

4897

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4898

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4899

"httpStatus": 42, # The HTTP status code used to abort the request.

4900

# The value must be between 200 and 599 inclusive.

4901

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4902

# The value must be between 0.0 and 100.0 inclusive.

4903

},

4904

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4905

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4906

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4907

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4908

},

4909

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4910

# The value must be between 0.0 and 100.0 inclusive.

4911

},

4912

},

4913

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

4914

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4915

},

4916

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4917

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4918

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

4919

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

4920

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4921

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4922

},

4923

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4924

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

4925

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4926

# -

4927

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4928

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4929

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

4930

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4931

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4932

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4933

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

4938

# If not specified, will use the largest timeout among all backend services associated with the route.

4939

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4940

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4941

},

4942

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

4943

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

4944

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4945

# The value must be between 1 and 255 characters.

4946

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

4947

# The value must be between 1 and 1024 characters.

4948

},

4949

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

4950

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

4951

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

4952

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

4953

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

4954

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4955

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4956

{ # Specification determining how headers are added to requests or responses.

4957

"headerName": "A String", # The name of the header.

4958

"headerValue": "A String", # The value of the header to add.

4959

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4960

# The default value is false.

4961

},

4962

],

4963

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4964

"A String",

4965

],

4966

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4967

{ # Specification determining how headers are added to requests or responses.

4968

"headerName": "A String", # The name of the header.

4969

"headerValue": "A String", # The value of the header to add.

4970

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4971

# The default value is false.

4972

},

4973

],

4974

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

4979

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

4980

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

4985

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4986

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4987

# If urlRedirect is specified, service or routeAction must not be set.

4988

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4989

# The value must be between 1 and 255 characters.

4990

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

4991

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4992

# The default is set to false.

4993

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4994

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4995

# The value must be between 1 and 1024 characters.

4996

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4997

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

4998

# The value must be between 1 and 1024 characters.

4999

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5000

# Supported values are:

5001

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5002

# - FOUND, which corresponds to 302.

5003

# - SEE_OTHER which corresponds to 303.

5004

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5005

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5006

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

5007

# The default is set to false.

},

},

],

"routeRules": [ # The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.

5012

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5013

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5014

"description": "A String", # The short description conveying the intent of this routeRule.

5015

# The description can have a maximum length of 1024 characters.

5016

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

5017

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5018

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5019

{ # Specification determining how headers are added to requests or responses.

5020

"headerName": "A String", # The name of the header.

5021

"headerValue": "A String", # The value of the header to add.

5022

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5023

# The default value is false.

5024

},

5025

],

5026

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5027

"A String",

5028

],

5029

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5030

{ # Specification determining how headers are added to requests or responses.

5031

"headerName": "A String", # The name of the header.

5032

"headerValue": "A String", # The value of the header to add.

5033

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5034

# The default value is false.

5035

},

5036

],

5037

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5043

"fullPathMatch": "A String", # For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.

5044

# fullPathMatch must be between 1 and 1024 characters.

5045

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5046

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5047

{ # matchRule criteria for request header matches.

5048

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5049

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5050

"headerName": "A String", # The name of the HTTP header to match.

5051

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5052

# For matching a request's method, use the headerName ":method".

5053

"invertMatch": True or False, # If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.

5054

# The default setting is false.

5055

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5056

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5057

"presentMatch": True or False, # A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.

5058

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5059

"rangeMatch": { # HttpRouteRuleMatch criteria for field values that must stay within the specified integer range. # The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.

5060

# For example for a range [-5, 0]

5061

# - -3 will match.

5062

# - 0 will not match.

5063

# - 0.25 will not match.

5064

# - -3someString will not match.

5065

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5066

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5067

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5068

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5069

},

5070

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript

5071

# For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.

5072

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5073

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5074

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5075

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5076

},

5077

],

5078

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5079

# The default value is false.

5080

# ignoreCase must not be used with regexMatch.

5081

"metadataFilters": [ # Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.

5082

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

5083

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5084

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5085

{ # Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.

5086

# For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.

5087

# An example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node metadata of their XDS requests to loadbalancers.

5088

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5089

# This list must not be empty and can have at the most 64 entries.

5090

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5091

"name": "A String", # Name of metadata label.

5092

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5093

"value": "A String", # The value of the label must match the specified value.

5094

# value can have a maximum length of 1024 characters.

5095

},

5096

],

5097

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5098

# Supported values are:

5099

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5100

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5101

},

5102

],

5103

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5104

# The value must be between 1 and 1024 characters.

5105

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5106

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5107

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5108

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5109

# Only one of presentMatch, exactMatch or regexMatch must be set.

5110

"name": "A String", # The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

5111

"presentMatch": True or False, # Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.

5112

# Only one of presentMatch, exactMatch or regexMatch must be set.

5113

"regexMatch": "A String", # The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript

5114

# Only one of presentMatch, exactMatch or regexMatch must be set.

5115

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5116

},

5117

],

5118

"regexMatch": "A String", # For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5119

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5120

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5121

},

5122

],

5123

"priority": 42, # For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.

5124

# You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.

5125

# Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.

5126

"routeAction": { # In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.

5127

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5128

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

5129

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

5130

# Default is false.

5131

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5132

"A String",

5133

],

5134

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5135

"A String",

5136

],

5137

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5138

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5139

"A String",

5140

],

5141

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5142

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5143

"A String",

5144

],

5145

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

5146

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5147

"A String",

5148

],

5149

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5150

},

5151

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

5152

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5153

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

5154

"httpStatus": 42, # The HTTP status code used to abort the request.

5155

# The value must be between 200 and 599 inclusive.

5156

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5157

# The value must be between 0.0 and 100.0 inclusive.

5158

},

5159

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

5160

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

5161

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5162

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5163

},

5164

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5165

# The value must be between 0.0 and 100.0 inclusive.

5166

},

5167

},

5168

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

5169

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5170

},

5171

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5172

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5173

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

5174

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

5175

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5176

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5177

},

5178

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5179

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

5180

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5181

# -

5182

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5183

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5184

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

5185

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5186

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5187

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5188

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

"A String",

],

},

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

5193

# If not specified, will use the largest timeout among all backend services associated with the route.

5194

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5195

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5196

},

5197

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

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

[diff] [blame^]

5198

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

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

[diff] [blame]

5199

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5200

# The value must be between 1 and 255 characters.

5201

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

5202

# The value must be between 1 and 1024 characters.

5203

},

5204

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

5205

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

5206

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

5207

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

5208

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

5209

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5210

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5211

{ # Specification determining how headers are added to requests or responses.

5212

"headerName": "A String", # The name of the header.

5213

"headerValue": "A String", # The value of the header to add.

5214

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5215

# The default value is false.

5216

},

5217

],

5218

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5219

"A String",

5220

],

5221

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5222

{ # Specification determining how headers are added to requests or responses.

5223

"headerName": "A String", # The name of the header.

5224

"headerValue": "A String", # The value of the header to add.

5225

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5226

# The default value is false.

5227

},

5228

],

5229

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

5234

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

5235

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

5240

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5241

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5242

# If urlRedirect is specified, service or routeAction must not be set.

5243

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5244

# The value must be between 1 and 255 characters.

5245

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

5246

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5247

# The default is set to false.

5248

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5249

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

5250

# The value must be between 1 and 1024 characters.

5251

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5252

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

5253

# The value must be between 1 and 1024 characters.

5254

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5255

# Supported values are:

5256

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5257

# - FOUND, which corresponds to 302.

5258

# - SEE_OTHER which corresponds to 303.

5259

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5260

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5261

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

5262

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

5269

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5270

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

5271

{ # Message for the expected URL mappings.

5272

"description": "A String", # Description of this test case.

5273

"host": "A String", # Host portion of the URL.

5274

"path": "A String", # Path portion of the URL.

5275

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5276

},

5277

],

5278

},

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

5284

5285

{

Bu Sun Kim

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

[diff] [blame]

5286

"result": { # Message representing the validation result for a UrlMap.

"loadErrors": [

"A String",

],

"loadSucceeded": True or False, # Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.

5291

"testFailures": [

Bu Sun Kim

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

[diff] [blame]

5292

{

Bu Sun Kim

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

[diff] [blame]

5293

"actualService": "A String",

5294

"expectedService": "A String",

5295

"host": "A String",

5296

"path": "A String",

Bu Sun Kim

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

[diff] [blame]

5297

},

5298

],

Bu Sun Kim

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

[diff] [blame]

5299

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Bu Sun Kim