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

<p class="firstline">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.</p>

95

96

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

97

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

98

99

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

100

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

101

<h3>Method Details</h3>

102

103

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

104

<pre>Deletes the specified UrlMap resource.

105

106

Args:

107

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

108

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

109

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

110

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

111

112

Returns:

113

An object of the form:

114

115

{ # Represents an Operation resource.

116

#

117

# Google Compute Engine has three Operation resources:

118

#

119

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

120

#

121

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

122

#

123

# Operations can be global, regional or zonal.

124

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

125

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

126

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

127

#

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

{

136

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

137

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

138

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

},

],

},

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

{

160

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

161

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

162

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

163

{

164

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

165

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

166

},

167

],

168

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

169

},

170

],

171

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

}</pre>

</div>

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

177

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

178

179

Args:

180

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

181

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

182

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

183

184

Returns:

185

An object of the form:

186

187

{ # Represents a URL Map resource.

188

#

189

# Google Compute Engine has two URL Map resources:

190

#

191

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

192

#

193

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

194

#

195

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

196

#

197

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

198

#

199

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

200

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

201

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

202

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

203

"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

204

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

205

# Default is false.

206

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

207

"A String",

208

],

209

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

210

"A String",

211

],

212

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

213

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

214

"A String",

215

],

216

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

217

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

218

"A String",

219

],

220

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

221

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

222

"A String",

223

],

224

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

225

},

226

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

227

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

228

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

229

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

230

# The value must be between 200 and 599 inclusive.

231

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

232

# The value must be between 0.0 and 100.0 inclusive.

233

},

234

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

235

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

236

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

237

"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

238

},

239

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

240

# The value must be between 0.0 and 100.0 inclusive.

241

},

242

},

243

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

244

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

245

},

246

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

247

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

248

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

249

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

250

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

251

"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

252

},

253

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

254

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

255

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

256

# -

257

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

258

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

259

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

260

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

261

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

262

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

263

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

268

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

269

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

270

"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

271

},

272

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

273

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

274

# The value must be between 1 and 255 characters.

275

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

276

# The value must be between 1 and 1024 characters.

277

},

278

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

279

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

280

{ # 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

281

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

# The default value is false.

290

},

291

],

292

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

293

"A String",

294

],

295

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

296

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

297

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

298

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

299

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

300

# The default value is false.

301

},

302

],

303

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

308

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

309

# The value must be between 0 and 1000

},

],

},

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

314

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

315

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

316

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

317

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

318

# The value must be between 1 and 255 characters.

319

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

320

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

321

# The default is set to false.

322

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

323

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

324

# The value must be between 1 and 1024 characters.

325

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

326

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

327

# The value must be between 1 and 1024 characters.

328

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

329

# Supported values are:

330

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

331

# - FOUND, which corresponds to 302.

332

# - SEE_OTHER which corresponds to 303.

333

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

334

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

335

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

336

# The default is set to false.

337

},

338

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

339

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

340

#

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

# The default value is false.

350

},

351

],

352

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

353

"A String",

354

],

355

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

356

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

357

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

358

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

359

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

360

# The default value is false.

361

},

362

],

363

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

368

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

369

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

370

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

371

"A String",

372

],

373

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

374

},

375

],

376

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

377

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

378

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

379

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

380

{ # 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.

381

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

382

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

383

"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

384

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

385

# Default is false.

386

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

387

"A String",

388

],

389

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

390

"A String",

391

],

392

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

393

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

394

"A String",

395

],

396

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

397

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

398

"A String",

399

],

400

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

401

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

402

"A String",

403

],

404

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

405

},

406

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

407

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

408

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

409

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

410

# The value must be between 200 and 599 inclusive.

411

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

412

# The value must be between 0.0 and 100.0 inclusive.

413

},

414

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

415

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

416

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

417

"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

418

},

419

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

420

# The value must be between 0.0 and 100.0 inclusive.

421

},

422

},

423

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

424

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

425

},

426

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

427

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

428

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

429

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

430

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

431

"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

432

},

433

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

434

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

435

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

436

# -

437

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

438

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

439

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

440

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

441

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

442

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

443

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

448

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

449

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

450

"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

451

},

452

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

453

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

454

# The value must be between 1 and 255 characters.

455

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

456

# The value must be between 1 and 1024 characters.

457

},

458

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

459

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

460

{ # 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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

# The default value is false.

470

},

471

],

472

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

473

"A String",

474

],

475

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

476

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

477

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

478

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

479

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

480

# The default value is false.

481

},

482

],

483

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

488

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

489

# 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:

494

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

495

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

496

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

497

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

498

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

499

# - compute.backendBuckets.use

500

# - compute.backendServices.use

501

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

502

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

503

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

504

# The value must be between 1 and 255 characters.

505

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

506

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

507

# The default is set to false.

508

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

509

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

510

# The value must be between 1 and 1024 characters.

511

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

512

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

513

# The value must be between 1 and 1024 characters.

514

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

515

# Supported values are:

516

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

517

# - FOUND, which corresponds to 302.

518

# - SEE_OTHER which corresponds to 303.

519

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

520

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

521

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

522

# The default is set to false.

523

},

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

# The default value is false.

533

},

534

],

535

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

536

"A String",

537

],

538

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

539

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

540

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

541

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

542

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

543

# The default value is false.

544

},

545

],

546

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

551

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

552

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

553

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

554

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

555

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

556

"A String",

557

],

558

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

559

# Only one of routeAction or urlRedirect must be set.

560

"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

561

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

562

# Default is false.

563

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

564

"A String",

565

],

566

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

567

"A String",

568

],

569

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

570

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

571

"A String",

572

],

573

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

574

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

575

"A String",

576

],

577

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

578

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

579

"A String",

580

],

581

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

582

},

583

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

584

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

585

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

586

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

587

# The value must be between 200 and 599 inclusive.

588

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

589

# The value must be between 0.0 and 100.0 inclusive.

590

},

591

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

592

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

593

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

594

"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

595

},

596

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

597

# The value must be between 0.0 and 100.0 inclusive.

598

},

599

},

600

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

601

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

602

},

603

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

604

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

605

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

606

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

607

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

608

"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

609

},

610

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

611

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

612

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

613

# -

614

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

615

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

616

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

617

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

618

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

619

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

620

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

625

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

626

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

627

"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

628

},

629

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

630

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

631

# The value must be between 1 and 255 characters.

632

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

633

# The value must be between 1 and 1024 characters.

634

},

635

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

636

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

637

{ # 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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

# The default value is false.

647

},

648

],

649

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

650

"A String",

651

],

652

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

653

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

654

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

655

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

656

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

657

# The default value is false.

658

},

659

],

660

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

665

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

666

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

671

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

672

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

673

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

674

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

675

# The value must be between 1 and 255 characters.

676

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

677

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

678

# The default is set to false.

679

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

680

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

681

# The value must be between 1 and 1024 characters.

682

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

683

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

684

# The value must be between 1 and 1024 characters.

685

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

686

# Supported values are:

687

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

688

# - FOUND, which corresponds to 302.

689

# - SEE_OTHER which corresponds to 303.

690

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

691

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

692

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

693

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

698

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

699

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

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

# The default value is false.

710

},

711

],

712

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

713

"A String",

714

],

715

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

716

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

717

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

718

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

719

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

720

# The default value is false.

721

},

722

],

723

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

729

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

730

# fullPathMatch must be between 1 and 1024 characters.

731

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

732

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

733

{ # matchRule criteria for request header matches.

734

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

735

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

736

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

737

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

738

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

739

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

740

# The default setting is false.

741

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

742

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

743

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

744

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

745

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

746

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

747

# - -3 will match.

748

# - 0 will not match.

749

# - 0.25 will not match.

750

# - -3someString will not match.

751

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

752

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

753

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

754

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

755

},

756

"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

757

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

758

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

759

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

760

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

761

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

762

},

763

],

764

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

765

# The default value is false.

766

# ignoreCase must not be used with regexMatch.

767

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

768

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

769

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

770

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

771

{ # 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.

772

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

773

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

774

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

775

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

776

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

777

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

778

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

779

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

780

# value can have a maximum length of 1024 characters.

781

},

782

],

783

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

784

# Supported values are:

785

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

786

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

787

},

788

],

789

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

790

# The value must be between 1 and 1024 characters.

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

"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

800

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

801

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

802

},

803

],

804

"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

805

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

806

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

807

},

808

],

809

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

810

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

811

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

812

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

813

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

814

"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

815

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

816

# Default is false.

817

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

818

"A String",

819

],

820

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

821

"A String",

822

],

823

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

824

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

825

"A String",

826

],

827

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

828

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

829

"A String",

830

],

831

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

832

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

833

"A String",

834

],

835

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

836

},

837

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

838

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

839

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

840

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

841

# The value must be between 200 and 599 inclusive.

842

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

843

# The value must be between 0.0 and 100.0 inclusive.

844

},

845

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

846

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

847

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

848

"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

849

},

850

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

851

# The value must be between 0.0 and 100.0 inclusive.

852

},

853

},

854

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

855

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

856

},

857

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

858

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

859

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

860

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

861

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

862

"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

863

},

864

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

865

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

866

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

867

# -

868

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

869

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

870

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

871

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

872

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

873

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

874

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

879

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

880

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

881

"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

882

},

883

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

884

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

885

# The value must be between 1 and 255 characters.

886

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

887

# The value must be between 1 and 1024 characters.

888

},

889

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

890

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

891

{ # 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

892

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

893

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

894

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

895

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

896

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

897

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

898

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

899

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

900

# The default value is false.

901

},

902

],

903

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

904

"A String",

905

],

906

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

907

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

908

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

909

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

910

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

911

# The default value is false.

912

},

913

],

914

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

919

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

920

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

925

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

926

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

927

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

928

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

929

# The value must be between 1 and 255 characters.

930

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

931

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

932

# The default is set to false.

933

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

934

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

935

# The value must be between 1 and 1024 characters.

936

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

937

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

938

# The value must be between 1 and 1024 characters.

939

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

940

# Supported values are:

941

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

942

# - FOUND, which corresponds to 302.

943

# - SEE_OTHER which corresponds to 303.

944

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

945

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

946

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

947

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

954

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

955

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

956

{ # Message for the expected URL mappings.

957

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

958

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

959

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

960

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

},

],

}</pre>

</div>

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

968

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

969

970

Args:

971

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

972

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

973

body: object, The request body.

974

The object takes the form of:

975

976

{ # Represents a URL Map resource.

977

#

978

# Google Compute Engine has two URL Map resources:

979

#

980

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

981

#

982

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

983

#

984

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

985

#

986

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

987

#

988

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

989

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

990

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

991

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

992

"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

993

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

994

# Default is false.

995

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

996

"A String",

997

],

998

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

999

"A String",

1000

],

1001

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

1002

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

1003

"A String",

1004

],

1005

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

1006

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

1007

"A String",

1008

],

1009

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

1010

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

1011

"A String",

1012

],

1013

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

1014

},

1015

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

1016

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

1017

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

1018

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

1019

# The value must be between 200 and 599 inclusive.

1020

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

1021

# The value must be between 0.0 and 100.0 inclusive.

1022

},

1023

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

1024

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

1025

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

1026

"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

1027

},

1028

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

1029

# The value must be between 0.0 and 100.0 inclusive.

1030

},

1031

},

1032

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

1033

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

1034

},

1035

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

1036

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

1037

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

1038

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

1039

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

1040

"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

1041

},

1042

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

1043

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

1044

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

1045

# -

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1057

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

1058

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

1059

"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

1060

},

1061

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

1062

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

1063

# The value must be between 1 and 255 characters.

1064

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

1065

# The value must be between 1 and 1024 characters.

1066

},

1067

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

1068

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

1069

{ # 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

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

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

1078

# The default value is false.

1079

},

1080

],

1081

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

1082

"A String",

1083

],

1084

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

1085

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

1086

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

1087

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

1088

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

1089

# The default value is false.

1090

},

1091

],

1092

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

1097

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

1098

# The value must be between 0 and 1000

},

],

},

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

1103

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

1104

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

1105

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

1106

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

1107

# The value must be between 1 and 255 characters.

1108

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

1109

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

1110

# The default is set to false.

1111

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

1112

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

1113

# The value must be between 1 and 1024 characters.

1114

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

1115

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

1116

# The value must be between 1 and 1024 characters.

1117

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

1118

# Supported values are:

1119

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

1120

# - FOUND, which corresponds to 302.

1121

# - SEE_OTHER which corresponds to 303.

1122

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

1123

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

1124

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

1125

# The default is set to false.

1126

},

1127

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

1128

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

1129

#

1130

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

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

# The default value is false.

1139

},

1140

],

1141

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

1142

"A String",

1143

],

1144

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

1145

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

1146

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

1147

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

1148

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

1149

# The default value is false.

1150

},

1151

],

1152

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

1157

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

1158

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

1159

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

1160

"A String",

1161

],

1162

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

1163

},

1164

],

1165

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

1166

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

1167

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

1168

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

1169

{ # 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.

1170

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

1171

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1172

"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

1173

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

1174

# Default is false.

1175

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

1176

"A String",

1177

],

1178

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

1179

"A String",

1180

],

1181

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

1182

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

1183

"A String",

1184

],

1185

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

1186

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

1187

"A String",

1188

],

1189

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

1190

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

1191

"A String",

1192

],

1193

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

1194

},

1195

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

1196

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

1197

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

1198

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

1199

# The value must be between 200 and 599 inclusive.

1200

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

1201

# The value must be between 0.0 and 100.0 inclusive.

1202

},

1203

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

1204

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

1205

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

1206

"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

1207

},

1208

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

1209

# The value must be between 0.0 and 100.0 inclusive.

1210

},

1211

},

1212

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

1213

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

1214

},

1215

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

1216

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

1217

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

1218

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

1219

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

1220

"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

1221

},

1222

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

1223

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

1224

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

1225

# -

1226

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

1227

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

1228

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

1229

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

1230

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

1231

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

1232

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

1237

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

1238

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

1239

"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

1240

},

1241

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

1242

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

1243

# The value must be between 1 and 255 characters.

1244

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

1245

# The value must be between 1 and 1024 characters.

1246

},

1247

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

1248

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

1249

{ # 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

1250

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

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

1258

# The default value is false.

1259

},

1260

],

1261

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

1262

"A String",

1263

],

1264

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

1265

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

1266

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

1267

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

1268

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

1269

# The default value is false.

1270

},

1271

],

1272

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

1277

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

1278

# 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:

1283

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

1284

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

1285

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

1286

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

1287

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

1288

# - compute.backendBuckets.use

1289

# - compute.backendServices.use

1290

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

1291

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

1292

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

1293

# The value must be between 1 and 255 characters.

1294

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

1295

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

1296

# The default is set to false.

1297

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

1298

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

1299

# The value must be between 1 and 1024 characters.

1300

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

1301

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

1302

# The value must be between 1 and 1024 characters.

1303

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

1304

# Supported values are:

1305

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

1306

# - FOUND, which corresponds to 302.

1307

# - SEE_OTHER which corresponds to 303.

1308

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

1309

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

1310

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

1311

# The default is set to false.

1312

},

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1320

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

1321

# The default value is false.

1322

},

1323

],

1324

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

1325

"A String",

1326

],

1327

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

1328

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

1329

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

1330

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

1331

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

1332

# The default value is false.

1333

},

1334

],

1335

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

"A String",

1346

],

1347

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

1348

# Only one of routeAction or urlRedirect must be set.

1349

"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

1350

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

1351

# Default is false.

1352

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

1353

"A String",

1354

],

1355

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

1356

"A String",

1357

],

1358

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

1359

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

1360

"A String",

1361

],

1362

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

1363

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

1364

"A String",

1365

],

1366

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

1367

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

1368

"A String",

1369

],

1370

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

1371

},

1372

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

1373

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

1374

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

1375

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

1376

# The value must be between 200 and 599 inclusive.

1377

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

1378

# The value must be between 0.0 and 100.0 inclusive.

1379

},

1380

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

1381

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

1382

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

1383

"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

1384

},

1385

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

1386

# The value must be between 0.0 and 100.0 inclusive.

1387

},

1388

},

1389

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

1390

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

1391

},

1392

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

1393

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

1394

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

1395

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

1396

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

1397

"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

1398

},

1399

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

1400

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

1401

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

1402

# -

1403

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

1404

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

1405

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

1406

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

1407

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

1408

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

1409

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

1414

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

1415

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

1416

"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

1417

},

1418

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

1419

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

1420

# The value must be between 1 and 255 characters.

1421

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

1422

# The value must be between 1 and 1024 characters.

1423

},

1424

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

1425

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

1426

{ # 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

1427

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

1428

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

1429

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

1430

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

1431

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

1432

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

1433

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

1434

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

1435

# The default value is false.

1436

},

1437

],

1438

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

1439

"A String",

1440

],

1441

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

1442

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

1443

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

1444

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

1445

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

1446

# The default value is false.

1447

},

1448

],

1449

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

1454

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

1455

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

1460

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

1461

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

1462

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

1463

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

1464

# The value must be between 1 and 255 characters.

1465

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

1466

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

1467

# The default is set to false.

1468

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

1469

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

1470

# The value must be between 1 and 1024 characters.

1471

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

1472

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

1473

# The value must be between 1 and 1024 characters.

1474

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

1475

# Supported values are:

1476

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

1477

# - FOUND, which corresponds to 302.

1478

# - SEE_OTHER which corresponds to 303.

1479

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

1480

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

1481

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

1482

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

1487

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

1488

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

1489

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

1490

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

1491

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

1492

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

1493

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

1494

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

1495

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

1496

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

1497

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

1498

# The default value is false.

1499

},

1500

],

1501

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

1502

"A String",

1503

],

1504

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

1505

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

1506

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

1507

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

1508

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

1509

# The default value is false.

1510

},

1511

],

1512

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

1518

"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.

1519

# fullPathMatch must be between 1 and 1024 characters.

1520

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1521

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1522

{ # matchRule criteria for request header matches.

1523

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1524

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1525

"headerName": "A String", # The name of the HTTP header to match.

1526

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1527

# For matching a request's method, use the headerName ":method".

1528

"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.

1529

# The default setting is false.

1530

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1531

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1532

"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.

1533

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1534

"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.

1535

# For example for a range [-5, 0]

1536

# - -3 will match.

1537

# - 0 will not match.

1538

# - 0.25 will not match.

1539

# - -3someString will not match.

1540

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1541

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1542

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1543

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1544

},

1545

"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

1546

# 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.

1547

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1548

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1549

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1550

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1551

},

1552

],

1553

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1554

# The default value is false.

1555

# ignoreCase must not be used with regexMatch.

1556

"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.

1557

# 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.

1558

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1559

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1560

{ # 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.

1561

# 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.

1562

# 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.

1563

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1564

# This list must not be empty and can have at the most 64 entries.

1565

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1566

"name": "A String", # Name of metadata label.

1567

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1568

"value": "A String", # The value of the label must match the specified value.

1569

# value can have a maximum length of 1024 characters.

1570

},

1571

],

1572

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1573

# Supported values are:

1574

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1575

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1576

},

1577

],

1578

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1579

# The value must be between 1 and 1024 characters.

1580

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1581

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1582

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1583

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1584

# Only one of presentMatch, exactMatch or regexMatch must be set.

1585

"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.

1586

"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.

1587

# Only one of presentMatch, exactMatch or regexMatch must be set.

1588

"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

1589

# Only one of presentMatch, exactMatch or regexMatch must be set.

1590

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1591

},

1592

],

1593

"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

1594

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1595

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1596

},

1597

],

1598

"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.

1599

# 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.

1600

# 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.

1601

"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.

1602

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1603

"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

1604

"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.

1605

# Default is false.

1606

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1607

"A String",

1608

],

1609

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1610

"A String",

1611

],

1612

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1613

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1614

"A String",

1615

],

1616

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1617

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1618

"A String",

1619

],

1620

"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.

1621

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1622

"A String",

1623

],

1624

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1625

},

1626

"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.

1627

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1628

"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.

1629

"httpStatus": 42, # The HTTP status code used to abort the request.

1630

# The value must be between 200 and 599 inclusive.

1631

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1632

# The value must be between 0.0 and 100.0 inclusive.

1633

},

1634

"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.

1635

"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.

1636

"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.

1637

"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

1638

},

1639

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1640

# The value must be between 0.0 and 100.0 inclusive.

1641

},

1642

},

1643

"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.

1644

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1645

},

1646

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1647

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1648

"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.

1649

# 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.

1650

"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.

1651

"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

1652

},

1653

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1654

# - 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.

1655

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1656

# -

1657

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1658

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1659

# - 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.

1660

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1661

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1662

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1663

# - 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.

1668

# If not specified, will use the largest timeout among all backend services associated with the route.

1669

"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.

1670

"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

1671

},

1672

"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.

1673

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1674

# The value must be between 1 and 255 characters.

1675

"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.

1676

# The value must be between 1 and 1024 characters.

1677

},

1678

"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.

1679

# 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.

1680

{ # 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

1681

"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.

1682

"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.

1683

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1684

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1685

{ # Specification determining how headers are added to requests or responses.

1686

"headerName": "A String", # The name of the header.

1687

"headerValue": "A String", # The value of the header to add.

1688

"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.

1689

# The default value is false.

1690

},

1691

],

1692

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1693

"A String",

1694

],

1695

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1696

{ # Specification determining how headers are added to requests or responses.

1697

"headerName": "A String", # The name of the header.

1698

"headerValue": "A String", # The value of the header to add.

1699

"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.

1700

# The default value is false.

1701

},

1702

],

1703

"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) .

1708

# 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.

1709

# 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.

1714

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1715

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1716

# If urlRedirect is specified, service or routeAction must not be set.

1717

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1718

# The value must be between 1 and 255 characters.

1719

"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.

1720

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1721

# The default is set to false.

1722

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1723

# 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.

1724

# The value must be between 1 and 1024 characters.

1725

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1726

# 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.

1727

# The value must be between 1 and 1024 characters.

1728

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1729

# Supported values are:

1730

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1731

# - FOUND, which corresponds to 302.

1732

# - SEE_OTHER which corresponds to 303.

1733

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1734

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1735

"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.

1736

# 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.

1743

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1744

"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.

1745

{ # Message for the expected URL mappings.

1746

"description": "A String", # Description of this test case.

1747

"host": "A String", # Host portion of the URL.

1748

"path": "A String", # Path portion of the URL.

1749

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

},

],

}

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

1755

1756

Returns:

1757

An object of the form:

1758

1759

{ # Represents an Operation resource.

1760

#

1761

# Google Compute Engine has three Operation resources:

1762

#

1763

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1764

#

1765

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1766

#

1767

# Operations can be global, regional or zonal.

1768

# - For global operations, use the `globalOperations` resource.

1769

# - For regional operations, use the `regionOperations` resource.

1770

# - For zonal operations, use the `zonalOperations` resource.

1771

#

1772

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

1773

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1774

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1775

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1776

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1777

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1778

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

1779

{

1780

"code": "A String", # [Output Only] The error type identifier for this error.

1781

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1782

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1787

"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.

1788

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1789

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1790

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1791

"name": "A String", # [Output Only] Name of the operation.

1792

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1793

"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.

1794

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1795

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1796

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1797

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1798

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1799

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1800

"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.

1801

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1802

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1803

{

1804

"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.

1805

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1806

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1807

{

1808

"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).

1809

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1810

},

1811

],

1812

"message": "A String", # [Output Only] A human-readable description of the warning code.

1813

},

1814

],

1815

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

1821

<pre>Retrieves the list of UrlMap resources available to the specified project in the specified region.

1822

1823

Args:

1824

project: string, Project ID for this request. (required)

1825

region: string, Name of the region scoping this request. (required)

1826

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 `<`.

1827

1828

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

1829

1830

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.

1831

1832

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) ```

1833

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`)

1834

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1835

1836

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.

1837

1838

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1839

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.

1840

1841

Returns:

1842

An object of the form:

1843

1844

{ # Contains a list of UrlMap resources.

1845

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1846

"items": [ # A list of UrlMap resources.

1847

{ # Represents a URL Map resource.

1848

#

1849

# Google Compute Engine has two URL Map resources:

1850

#

1851

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1852

#

1853

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1854

#

1855

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1856

#

1857

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1858

#

1859

# 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.

1860

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1861

"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.

1862

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1863

"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

1864

"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.

1865

# Default is false.

1866

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1867

"A String",

1868

],

1869

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1870

"A String",

1871

],

1872

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1873

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1874

"A String",

1875

],

1876

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1877

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1878

"A String",

1879

],

1880

"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.

1881

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1882

"A String",

1883

],

1884

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1885

},

1886

"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.

1887

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1888

"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.

1889

"httpStatus": 42, # The HTTP status code used to abort the request.

1890

# The value must be between 200 and 599 inclusive.

1891

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1892

# The value must be between 0.0 and 100.0 inclusive.

1893

},

1894

"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.

1895

"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.

1896

"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.

1897

"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

1898

},

1899

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1900

# The value must be between 0.0 and 100.0 inclusive.

1901

},

1902

},

1903

"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.

1904

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1905

},

1906

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1907

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1908

"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.

1909

# 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.

1910

"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.

1911

"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

1912

},

1913

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1914

# - 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.

1915

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1916

# -

1917

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1918

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1919

# - 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.

1920

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1921

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1922

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1923

# - 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.

1928

# If not specified, will use the largest timeout among all backend services associated with the route.

1929

"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.

1930

"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

1931

},

1932

"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.

1933

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1934

# The value must be between 1 and 255 characters.

1935

"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.

1936

# The value must be between 1 and 1024 characters.

1937

},

1938

"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.

1939

# 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.

1940

{ # 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

1941

"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.

1942

"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.

1943

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1944

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1945

{ # Specification determining how headers are added to requests or responses.

1946

"headerName": "A String", # The name of the header.

1947

"headerValue": "A String", # The value of the header to add.

1948

"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.

1949

# The default value is false.

1950

},

1951

],

1952

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1953

"A String",

1954

],

1955

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1956

{ # Specification determining how headers are added to requests or responses.

1957

"headerName": "A String", # The name of the header.

1958

"headerValue": "A String", # The value of the header to add.

1959

"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.

1960

# The default value is false.

1961

},

1962

],

1963

"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) .

1968

# 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.

1969

# The value must be between 0 and 1000

},

],

},

"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.

1974

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1975

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1976

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1977

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1978

# The value must be between 1 and 255 characters.

1979

"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.

1980

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1981

# The default is set to false.

1982

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1983

# 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.

1984

# The value must be between 1 and 1024 characters.

1985

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1986

# 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.

1987

# The value must be between 1 and 1024 characters.

1988

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1989

# Supported values are:

1990

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1991

# - FOUND, which corresponds to 302.

1992

# - SEE_OTHER which corresponds to 303.

1993

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1994

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1995

"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.

1996

# The default is set to false.

1997

},

1998

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1999

"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.

2000

#

2001

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2002

"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.

2003

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2004

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2005

{ # Specification determining how headers are added to requests or responses.

2006

"headerName": "A String", # The name of the header.

2007

"headerValue": "A String", # The value of the header to add.

2008

"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.

2009

# The default value is false.

2010

},

2011

],

2012

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2013

"A String",

2014

],

2015

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2016

{ # Specification determining how headers are added to requests or responses.

2017

"headerName": "A String", # The name of the header.

2018

"headerValue": "A String", # The value of the header to add.

2019

"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.

2020

# The default value is false.

2021

},

2022

],

2023

"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.

2028

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2029

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2030

"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 ..

2031

"A String",

2032

],

2033

"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.

2034

},

2035

],

2036

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2037

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2038

"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.

2039

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2040

{ # 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.

2041

"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.

2042

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2043

"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

2044

"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.

2045

# Default is false.

2046

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2047

"A String",

2048

],

2049

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2050

"A String",

2051

],

2052

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2053

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2054

"A String",

2055

],

2056

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2057

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2058

"A String",

2059

],

2060

"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.

2061

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2062

"A String",

2063

],

2064

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2065

},

2066

"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.

2067

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2068

"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.

2069

"httpStatus": 42, # The HTTP status code used to abort the request.

2070

# The value must be between 200 and 599 inclusive.

2071

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2072

# The value must be between 0.0 and 100.0 inclusive.

2073

},

2074

"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.

2075

"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.

2076

"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.

2077

"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

2078

},

2079

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2080

# The value must be between 0.0 and 100.0 inclusive.

2081

},

2082

},

2083

"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.

2084

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2085

},

2086

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2087

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2088

"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.

2089

# 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.

2090

"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.

2091

"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

2092

},

2093

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2094

# - 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.

2095

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2096

# -

2097

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2098

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2099

# - 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.

2100

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2101

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2102

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2103

# - 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.

2108

# If not specified, will use the largest timeout among all backend services associated with the route.

2109

"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.

2110

"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

2111

},

2112

"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.

2113

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2114

# The value must be between 1 and 255 characters.

2115

"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.

2116

# The value must be between 1 and 1024 characters.

2117

},

2118

"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.

2119

# 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.

2120

{ # 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

2121

"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.

2122

"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.

2123

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2124

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2125

{ # Specification determining how headers are added to requests or responses.

2126

"headerName": "A String", # The name of the header.

2127

"headerValue": "A String", # The value of the header to add.

2128

"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.

2129

# The default value is false.

2130

},

2131

],

2132

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2133

"A String",

2134

],

2135

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2136

{ # Specification determining how headers are added to requests or responses.

2137

"headerName": "A String", # The name of the header.

2138

"headerValue": "A String", # The value of the header to add.

2139

"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.

2140

# The default value is false.

2141

},

2142

],

2143

"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) .

2148

# 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.

2149

# 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:

2154

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2155

# - compute/v1/projects/project/global/backendServices/backendService

2156

# - 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.

2157

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2158

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2159

# - compute.backendBuckets.use

2160

# - compute.backendServices.use

2161

"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.

2162

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2163

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2164

# The value must be between 1 and 255 characters.

2165

"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.

2166

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2167

# The default is set to false.

2168

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2169

# 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.

2170

# The value must be between 1 and 1024 characters.

2171

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2172

# 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.

2173

# The value must be between 1 and 1024 characters.

2174

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2175

# Supported values are:

2176

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2177

# - FOUND, which corresponds to 302.

2178

# - SEE_OTHER which corresponds to 303.

2179

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2180

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2181

"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.

2182

# The default is set to false.

2183

},

2184

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2185

"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.

2186

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2187

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2188

{ # Specification determining how headers are added to requests or responses.

2189

"headerName": "A String", # The name of the header.

2190

"headerValue": "A String", # The value of the header to add.

2191

"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.

2192

# The default value is false.

2193

},

2194

],

2195

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2196

"A String",

2197

],

2198

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2199

{ # Specification determining how headers are added to requests or responses.

2200

"headerName": "A String", # The name of the header.

2201

"headerValue": "A String", # The value of the header to add.

2202

"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.

2203

# The default value is false.

2204

},

2205

],

2206

"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.

2211

"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.

2212

# 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.

2213

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2214

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2215

"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.

2216

"A String",

2217

],

2218

"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.

2219

# Only one of routeAction or urlRedirect must be set.

2220

"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

2221

"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.

2222

# Default is false.

2223

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2224

"A String",

2225

],

2226

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2227

"A String",

2228

],

2229

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2230

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2231

"A String",

2232

],

2233

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2234

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2235

"A String",

2236

],

2237

"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.

2238

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2239

"A String",

2240

],

2241

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2242

},

2243

"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.

2244

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2245

"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.

2246

"httpStatus": 42, # The HTTP status code used to abort the request.

2247

# The value must be between 200 and 599 inclusive.

2248

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2249

# The value must be between 0.0 and 100.0 inclusive.

2250

},

2251

"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.

2252

"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.

2253

"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.

2254

"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

2255

},

2256

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2257

# The value must be between 0.0 and 100.0 inclusive.

2258

},

2259

},

2260

"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.

2261

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2262

},

2263

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2264

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2265

"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.

2266

# 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.

2267

"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.

2268

"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

2269

},

2270

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2271

# - 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.

2272

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2273

# -

2274

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2275

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2276

# - 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.

2277

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2278

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2279

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2280

# - 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.

2285

# If not specified, will use the largest timeout among all backend services associated with the route.

2286

"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.

2287

"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

2288

},

2289

"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.

2290

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2291

# The value must be between 1 and 255 characters.

2292

"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.

2293

# The value must be between 1 and 1024 characters.

2294

},

2295

"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.

2296

# 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.

2297

{ # 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

2298

"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.

2299

"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.

2300

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2301

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2302

{ # Specification determining how headers are added to requests or responses.

2303

"headerName": "A String", # The name of the header.

2304

"headerValue": "A String", # The value of the header to add.

2305

"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.

2306

# The default value is false.

2307

},

2308

],

2309

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2310

"A String",

2311

],

2312

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2313

{ # Specification determining how headers are added to requests or responses.

2314

"headerName": "A String", # The name of the header.

2315

"headerValue": "A String", # The value of the header to add.

2316

"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.

2317

# The default value is false.

2318

},

2319

],

2320

"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) .

2325

# 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.

2326

# 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.

2331

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2332

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2333

# If urlRedirect is specified, service or routeAction must not be set.

2334

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2335

# The value must be between 1 and 255 characters.

2336

"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.

2337

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2338

# The default is set to false.

2339

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2340

# 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.

2341

# The value must be between 1 and 1024 characters.

2342

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2343

# 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.

2344

# The value must be between 1 and 1024 characters.

2345

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2346

# Supported values are:

2347

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2348

# - FOUND, which corresponds to 302.

2349

# - SEE_OTHER which corresponds to 303.

2350

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2351

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2352

"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.

2353

# 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.

2358

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2359

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2360

"description": "A String", # The short description conveying the intent of this routeRule.

2361

# The description can have a maximum length of 1024 characters.

2362

"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.

2363

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2364

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2365

{ # Specification determining how headers are added to requests or responses.

2366

"headerName": "A String", # The name of the header.

2367

"headerValue": "A String", # The value of the header to add.

2368

"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.

2369

# The default value is false.

2370

},

2371

],

2372

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2373

"A String",

2374

],

2375

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2376

{ # Specification determining how headers are added to requests or responses.

2377

"headerName": "A String", # The name of the header.

2378

"headerValue": "A String", # The value of the header to add.

2379

"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.

2380

# The default value is false.

2381

},

2382

],

2383

"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.

2389

"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.

2390

# fullPathMatch must be between 1 and 1024 characters.

2391

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2392

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2393

{ # matchRule criteria for request header matches.

2394

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2395

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2396

"headerName": "A String", # The name of the HTTP header to match.

2397

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2398

# For matching a request's method, use the headerName ":method".

2399

"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.

2400

# The default setting is false.

2401

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2402

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2403

"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.

2404

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2405

"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.

2406

# For example for a range [-5, 0]

2407

# - -3 will match.

2408

# - 0 will not match.

2409

# - 0.25 will not match.

2410

# - -3someString will not match.

2411

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2412

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2413

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2414

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2415

},

2416

"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

2417

# 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.

2418

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2419

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2420

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2421

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2422

},

2423

],

2424

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2425

# The default value is false.

2426

# ignoreCase must not be used with regexMatch.

2427

"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.

2428

# 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.

2429

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2430

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2431

{ # 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.

2432

# 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.

2433

# 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.

2434

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2435

# This list must not be empty and can have at the most 64 entries.

2436

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2437

"name": "A String", # Name of metadata label.

2438

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2439

"value": "A String", # The value of the label must match the specified value.

2440

# value can have a maximum length of 1024 characters.

2441

},

2442

],

2443

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2444

# Supported values are:

2445

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2446

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2447

},

2448

],

2449

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2450

# The value must be between 1 and 1024 characters.

2451

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2452

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2453

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2454

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2455

# Only one of presentMatch, exactMatch or regexMatch must be set.

2456

"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.

2457

"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.

2458

# Only one of presentMatch, exactMatch or regexMatch must be set.

2459

"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

2460

# Only one of presentMatch, exactMatch or regexMatch must be set.

2461

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2462

},

2463

],

2464

"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

2465

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2466

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2467

},

2468

],

2469

"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.

2470

# 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.

2471

# 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.

2472

"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.

2473

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2474

"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

2475

"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.

2476

# Default is false.

2477

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2478

"A String",

2479

],

2480

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2481

"A String",

2482

],

2483

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2484

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2485

"A String",

2486

],

2487

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2488

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2489

"A String",

2490

],

2491

"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.

2492

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2493

"A String",

2494

],

2495

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2496

},

2497

"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.

2498

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2499

"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.

2500

"httpStatus": 42, # The HTTP status code used to abort the request.

2501

# The value must be between 200 and 599 inclusive.

2502

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2503

# The value must be between 0.0 and 100.0 inclusive.

2504

},

2505

"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.

2506

"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.

2507

"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.

2508

"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

2509

},

2510

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2511

# The value must be between 0.0 and 100.0 inclusive.

2512

},

2513

},

2514

"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.

2515

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2516

},

2517

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2518

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2519

"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.

2520

# 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.

2521

"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.

2522

"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

2523

},

2524

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2525

# - 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.

2526

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2527

# -

2528

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2529

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2530

# - 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.

2531

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2532

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2533

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2534

# - 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.

2539

# If not specified, will use the largest timeout among all backend services associated with the route.

2540

"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.

2541

"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

2542

},

2543

"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.

2544

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2545

# The value must be between 1 and 255 characters.

2546

"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.

2547

# The value must be between 1 and 1024 characters.

2548

},

2549

"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.

2550

# 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.

2551

{ # 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

2552

"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.

2553

"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.

2554

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2555

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2556

{ # Specification determining how headers are added to requests or responses.

2557

"headerName": "A String", # The name of the header.

2558

"headerValue": "A String", # The value of the header to add.

2559

"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.

2560

# The default value is false.

2561

},

2562

],

2563

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2564

"A String",

2565

],

2566

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2567

{ # Specification determining how headers are added to requests or responses.

2568

"headerName": "A String", # The name of the header.

2569

"headerValue": "A String", # The value of the header to add.

2570

"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.

2571

# The default value is false.

2572

},

2573

],

2574

"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) .

2579

# 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.

2580

# 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.

2585

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2586

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2587

# If urlRedirect is specified, service or routeAction must not be set.

2588

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2589

# The value must be between 1 and 255 characters.

2590

"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.

2591

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2592

# The default is set to false.

2593

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2594

# 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.

2595

# The value must be between 1 and 1024 characters.

2596

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2597

# 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.

2598

# The value must be between 1 and 1024 characters.

2599

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2600

# Supported values are:

2601

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2602

# - FOUND, which corresponds to 302.

2603

# - SEE_OTHER which corresponds to 303.

2604

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2605

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2606

"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.

2607

# 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.

2614

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2615

"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.

2616

{ # Message for the expected URL mappings.

2617

"description": "A String", # Description of this test case.

2618

"host": "A String", # Host portion of the URL.

2619

"path": "A String", # Path portion of the URL.

2620

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

},

],

},

],

"kind": "compute#urlMapList", # Type of resource.

2626

"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.

2627

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2628

"warning": { # [Output Only] Informational warning message.

2629

"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.

2630

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2631

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2632

{

2633

"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).

2634

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2635

},

2636

],

2637

"message": "A String", # [Output Only] A human-readable description of the warning code.

},

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2644

<pre>Retrieves the next page of results.

2645

2646

Args:

2647

previous_request: The request for the previous page. (required)

2648

previous_response: The response from the request for the previous page. (required)

2649

2650

Returns:

2651

A request object that you can call 'execute()' on to request the next

2652

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(project, region, urlMap, body=None, requestId=None)</code>

2658

<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.

2659

2660

Args:

2661

project: string, Project ID for this request. (required)

2662

region: string, Name of the region scoping this request. (required)

2663

urlMap: string, Name of the UrlMap resource to patch. (required)

2664

body: object, The request body.

2665

The object takes the form of:

2666

2667

{ # Represents a URL Map resource.

2668

#

2669

# Google Compute Engine has two URL Map resources:

2670

#

2671

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2672

#

2673

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2674

#

2675

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2676

#

2677

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2678

#

2679

# 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.

2680

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2681

"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.

2682

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2683

"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

2684

"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.

2685

# Default is false.

2686

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2687

"A String",

2688

],

2689

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2690

"A String",

2691

],

2692

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2693

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2694

"A String",

2695

],

2696

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2697

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2698

"A String",

2699

],

2700

"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.

2701

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2702

"A String",

2703

],

2704

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2705

},

2706

"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.

2707

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2708

"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.

2709

"httpStatus": 42, # The HTTP status code used to abort the request.

2710

# The value must be between 200 and 599 inclusive.

2711

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2712

# The value must be between 0.0 and 100.0 inclusive.

2713

},

2714

"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.

2715

"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.

2716

"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.

2717

"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

2718

},

2719

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2720

# The value must be between 0.0 and 100.0 inclusive.

2721

},

2722

},

2723

"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.

2724

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2725

},

2726

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2727

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2728

"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.

2729

# 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.

2730

"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.

2731

"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

2732

},

2733

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2734

# - 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.

2735

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2736

# -

2737

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2738

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2739

# - 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.

2740

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2741

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2742

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2743

# - 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.

2748

# If not specified, will use the largest timeout among all backend services associated with the route.

2749

"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.

2750

"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

2751

},

2752

"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.

2753

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2754

# The value must be between 1 and 255 characters.

2755

"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.

2756

# The value must be between 1 and 1024 characters.

2757

},

2758

"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.

2759

# 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.

2760

{ # 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

2761

"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.

2762

"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.

2763

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2764

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2765

{ # Specification determining how headers are added to requests or responses.

2766

"headerName": "A String", # The name of the header.

2767

"headerValue": "A String", # The value of the header to add.

2768

"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.

2769

# The default value is false.

2770

},

2771

],

2772

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2773

"A String",

2774

],

2775

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2776

{ # Specification determining how headers are added to requests or responses.

2777

"headerName": "A String", # The name of the header.

2778

"headerValue": "A String", # The value of the header to add.

2779

"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.

2780

# The default value is false.

2781

},

2782

],

2783

"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) .

2788

# 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.

2789

# The value must be between 0 and 1000

},

],

},

"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.

2794

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2795

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2796

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2797

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2798

# The value must be between 1 and 255 characters.

2799

"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.

2800

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2801

# The default is set to false.

2802

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2803

# 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.

2804

# The value must be between 1 and 1024 characters.

2805

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2806

# 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.

2807

# The value must be between 1 and 1024 characters.

2808

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2809

# Supported values are:

2810

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2811

# - FOUND, which corresponds to 302.

2812

# - SEE_OTHER which corresponds to 303.

2813

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2814

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2815

"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.

2816

# The default is set to false.

2817

},

2818

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2819

"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.

2820

#

2821

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2822

"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.

2823

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2824

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2825

{ # Specification determining how headers are added to requests or responses.

2826

"headerName": "A String", # The name of the header.

2827

"headerValue": "A String", # The value of the header to add.

2828

"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.

2829

# The default value is false.

2830

},

2831

],

2832

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2833

"A String",

2834

],

2835

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2836

{ # Specification determining how headers are added to requests or responses.

2837

"headerName": "A String", # The name of the header.

2838

"headerValue": "A String", # The value of the header to add.

2839

"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.

2840

# The default value is false.

2841

},

2842

],

2843

"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.

2848

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2849

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2850

"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 ..

2851

"A String",

2852

],

2853

"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.

2854

},

2855

],

2856

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2857

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2858

"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.

2859

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2860

{ # 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.

2861

"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.

2862

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2863

"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

2864

"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.

2865

# Default is false.

2866

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2867

"A String",

2868

],

2869

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2870

"A String",

2871

],

2872

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2873

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2874

"A String",

2875

],

2876

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2877

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2878

"A String",

2879

],

2880

"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.

2881

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2882

"A String",

2883

],

2884

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2885

},

2886

"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.

2887

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2888

"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.

2889

"httpStatus": 42, # The HTTP status code used to abort the request.

2890

# The value must be between 200 and 599 inclusive.

2891

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2892

# The value must be between 0.0 and 100.0 inclusive.

2893

},

2894

"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.

2895

"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.

2896

"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.

2897

"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

2898

},

2899

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2900

# The value must be between 0.0 and 100.0 inclusive.

2901

},

2902

},

2903

"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.

2904

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2905

},

2906

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2907

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2908

"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.

2909

# 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.

2910

"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.

2911

"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

2912

},

2913

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2914

# - 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.

2915

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2916

# -

2917

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2918

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2919

# - 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.

2920

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2921

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2922

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2923

# - 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.

2928

# If not specified, will use the largest timeout among all backend services associated with the route.

2929

"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.

2930

"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

2931

},

2932

"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.

2933

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2934

# The value must be between 1 and 255 characters.

2935

"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.

2936

# The value must be between 1 and 1024 characters.

2937

},

2938

"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.

2939

# 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.

2940

{ # 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

2941

"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.

2942

"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.

2943

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2944

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2945

{ # Specification determining how headers are added to requests or responses.

2946

"headerName": "A String", # The name of the header.

2947

"headerValue": "A String", # The value of the header to add.

2948

"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.

2949

# The default value is false.

2950

},

2951

],

2952

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2953

"A String",

2954

],

2955

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2956

{ # Specification determining how headers are added to requests or responses.

2957

"headerName": "A String", # The name of the header.

2958

"headerValue": "A String", # The value of the header to add.

2959

"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.

2960

# The default value is false.

2961

},

2962

],

2963

"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) .

2968

# 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.

2969

# 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:

2974

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2975

# - compute/v1/projects/project/global/backendServices/backendService

2976

# - 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.

2977

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2978

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2979

# - compute.backendBuckets.use

2980

# - compute.backendServices.use

2981

"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.

2982

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2983

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2984

# The value must be between 1 and 255 characters.

2985

"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.

2986

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2987

# The default is set to false.

2988

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2989

# 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.

2990

# The value must be between 1 and 1024 characters.

2991

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2992

# 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.

2993

# The value must be between 1 and 1024 characters.

2994

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2995

# Supported values are:

2996

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2997

# - FOUND, which corresponds to 302.

2998

# - SEE_OTHER which corresponds to 303.

2999

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3000

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3001

"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.

3002

# The default is set to false.

3003

},

3004

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3005

"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.

3006

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3007

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3008

{ # Specification determining how headers are added to requests or responses.

3009

"headerName": "A String", # The name of the header.

3010

"headerValue": "A String", # The value of the header to add.

3011

"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.

3012

# The default value is false.

3013

},

3014

],

3015

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3016

"A String",

3017

],

3018

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3019

{ # Specification determining how headers are added to requests or responses.

3020

"headerName": "A String", # The name of the header.

3021

"headerValue": "A String", # The value of the header to add.

3022

"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.

3023

# The default value is false.

3024

},

3025

],

3026

"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.

3031

"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.

3032

# 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.

3033

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3034

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3035

"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.

3036

"A String",

3037

],

3038

"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.

3039

# Only one of routeAction or urlRedirect must be set.

3040

"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

3041

"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.

3042

# Default is false.

3043

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3044

"A String",

3045

],

3046

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3047

"A String",

3048

],

3049

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3050

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3051

"A String",

3052

],

3053

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3054

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3055

"A String",

3056

],

3057

"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.

3058

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3059

"A String",

3060

],

3061

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3062

},

3063

"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.

3064

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3065

"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.

3066

"httpStatus": 42, # The HTTP status code used to abort the request.

3067

# The value must be between 200 and 599 inclusive.

3068

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3069

# The value must be between 0.0 and 100.0 inclusive.

3070

},

3071

"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.

3072

"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.

3073

"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.

3074

"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

3075

},

3076

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3077

# The value must be between 0.0 and 100.0 inclusive.

3078

},

3079

},

3080

"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.

3081

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3082

},

3083

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3084

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3085

"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.

3086

# 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.

3087

"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.

3088

"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

3089

},

3090

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3091

# - 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.

3092

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3093

# -

3094

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3095

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3096

# - 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.

3097

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3098

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3099

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3100

# - 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.

3105

# If not specified, will use the largest timeout among all backend services associated with the route.

3106

"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.

3107

"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

3108

},

3109

"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.

3110

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3111

# The value must be between 1 and 255 characters.

3112

"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.

3113

# The value must be between 1 and 1024 characters.

3114

},

3115

"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.

3116

# 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.

3117

{ # 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

3118

"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.

3119

"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.

3120

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3121

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3122

{ # Specification determining how headers are added to requests or responses.

3123

"headerName": "A String", # The name of the header.

3124

"headerValue": "A String", # The value of the header to add.

3125

"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.

3126

# The default value is false.

3127

},

3128

],

3129

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3130

"A String",

3131

],

3132

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3133

{ # Specification determining how headers are added to requests or responses.

3134

"headerName": "A String", # The name of the header.

3135

"headerValue": "A String", # The value of the header to add.

3136

"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.

3137

# The default value is false.

3138

},

3139

],

3140

"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) .

3145

# 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.

3146

# 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.

3151

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3152

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3153

# If urlRedirect is specified, service or routeAction must not be set.

3154

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3155

# The value must be between 1 and 255 characters.

3156

"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.

3157

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3158

# The default is set to false.

3159

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3160

# 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.

3161

# The value must be between 1 and 1024 characters.

3162

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3163

# 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.

3164

# The value must be between 1 and 1024 characters.

3165

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3166

# Supported values are:

3167

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3168

# - FOUND, which corresponds to 302.

3169

# - SEE_OTHER which corresponds to 303.

3170

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3171

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3172

"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.

3173

# 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.

3178

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3179

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3180

"description": "A String", # The short description conveying the intent of this routeRule.

3181

# The description can have a maximum length of 1024 characters.

3182

"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.

3183

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3184

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3185

{ # Specification determining how headers are added to requests or responses.

3186

"headerName": "A String", # The name of the header.

3187

"headerValue": "A String", # The value of the header to add.

3188

"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.

3189

# The default value is false.

3190

},

3191

],

3192

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3193

"A String",

3194

],

3195

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3196

{ # Specification determining how headers are added to requests or responses.

3197

"headerName": "A String", # The name of the header.

3198

"headerValue": "A String", # The value of the header to add.

3199

"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.

3200

# The default value is false.

3201

},

3202

],

3203

"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.

3209

"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.

3210

# fullPathMatch must be between 1 and 1024 characters.

3211

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3212

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3213

{ # matchRule criteria for request header matches.

3214

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3215

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3216

"headerName": "A String", # The name of the HTTP header to match.

3217

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3218

# For matching a request's method, use the headerName ":method".

3219

"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.

3220

# The default setting is false.

3221

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3222

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3223

"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.

3224

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3225

"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.

3226

# For example for a range [-5, 0]

3227

# - -3 will match.

3228

# - 0 will not match.

3229

# - 0.25 will not match.

3230

# - -3someString will not match.

3231

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3232

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3233

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3234

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3235

},

3236

"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

3237

# 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.

3238

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3239

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3240

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3241

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3242

},

3243

],

3244

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3245

# The default value is false.

3246

# ignoreCase must not be used with regexMatch.

3247

"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.

3248

# 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.

3249

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3250

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3251

{ # 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.

3252

# 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.

3253

# 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.

3254

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3255

# This list must not be empty and can have at the most 64 entries.

3256

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3257

"name": "A String", # Name of metadata label.

3258

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3259

"value": "A String", # The value of the label must match the specified value.

3260

# value can have a maximum length of 1024 characters.

3261

},

3262

],

3263

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3264

# Supported values are:

3265

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3266

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3267

},

3268

],

3269

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3270

# The value must be between 1 and 1024 characters.

3271

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3272

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3273

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3274

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3275

# Only one of presentMatch, exactMatch or regexMatch must be set.

3276

"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.

3277

"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.

3278

# Only one of presentMatch, exactMatch or regexMatch must be set.

3279

"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

3280

# Only one of presentMatch, exactMatch or regexMatch must be set.

3281

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3282

},

3283

],

3284

"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

3285

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3286

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3287

},

3288

],

3289

"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.

3290

# 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.

3291

# 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.

3292

"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.

3293

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3294

"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

3295

"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.

3296

# Default is false.

3297

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3298

"A String",

3299

],

3300

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3301

"A String",

3302

],

3303

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3304

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3305

"A String",

3306

],

3307

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3308

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3309

"A String",

3310

],

3311

"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.

3312

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3313

"A String",

3314

],

3315

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3316

},

3317

"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.

3318

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3319

"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.

3320

"httpStatus": 42, # The HTTP status code used to abort the request.

3321

# The value must be between 200 and 599 inclusive.

3322

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3323

# The value must be between 0.0 and 100.0 inclusive.

3324

},

3325

"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.

3326

"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.

3327

"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.

3328

"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

3329

},

3330

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3331

# The value must be between 0.0 and 100.0 inclusive.

3332

},

3333

},

3334

"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.

3335

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3336

},

3337

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3338

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3339

"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.

3340

# 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.

3341

"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.

3342

"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

3343

},

3344

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3345

# - 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.

3346

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3347

# -

3348

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3349

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3350

# - 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.

3351

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3352

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3353

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3354

# - 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.

3359

# If not specified, will use the largest timeout among all backend services associated with the route.

3360

"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.

3361

"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

3362

},

3363

"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.

3364

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3365

# The value must be between 1 and 255 characters.

3366

"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.

3367

# The value must be between 1 and 1024 characters.

3368

},

3369

"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.

3370

# 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.

3371

{ # 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

3372

"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.

3373

"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.

3374

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3375

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3376

{ # Specification determining how headers are added to requests or responses.

3377

"headerName": "A String", # The name of the header.

3378

"headerValue": "A String", # The value of the header to add.

3379

"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.

3380

# The default value is false.

3381

},

3382

],

3383

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3384

"A String",

3385

],

3386

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3387

{ # Specification determining how headers are added to requests or responses.

3388

"headerName": "A String", # The name of the header.

3389

"headerValue": "A String", # The value of the header to add.

3390

"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.

3391

# The default value is false.

3392

},

3393

],

3394

"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) .

3399

# 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.

3400

# 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.

3405

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3406

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3407

# If urlRedirect is specified, service or routeAction must not be set.

3408

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3409

# The value must be between 1 and 255 characters.

3410

"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.

3411

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3412

# The default is set to false.

3413

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3414

# 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.

3415

# The value must be between 1 and 1024 characters.

3416

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3417

# 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.

3418

# The value must be between 1 and 1024 characters.

3419

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3420

# Supported values are:

3421

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3422

# - FOUND, which corresponds to 302.

3423

# - SEE_OTHER which corresponds to 303.

3424

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3425

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3426

"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.

3427

# 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.

3434

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3435

"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.

3436

{ # Message for the expected URL mappings.

3437

"description": "A String", # Description of this test case.

3438

"host": "A String", # Host portion of the URL.

3439

"path": "A String", # Path portion of the URL.

3440

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

},

],

}

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

3446

3447

Returns:

3448

An object of the form:

3449

3450

{ # Represents an Operation resource.

3451

#

3452

# Google Compute Engine has three Operation resources:

3453

#

3454

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3455

#

3456

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3457

#

3458

# Operations can be global, regional or zonal.

3459

# - For global operations, use the `globalOperations` resource.

3460

# - For regional operations, use the `regionOperations` resource.

3461

# - For zonal operations, use the `zonalOperations` resource.

3462

#

3463

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

3464

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3465

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3466

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3467

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3468

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3469

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

3470

{

3471

"code": "A String", # [Output Only] The error type identifier for this error.

3472

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3473

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3478

"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.

3479

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3480

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3481

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3482

"name": "A String", # [Output Only] Name of the operation.

3483

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3484

"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.

3485

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3486

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3487

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3488

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3489

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3490

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3491

"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.

3492

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3493

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3494

{

3495

"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.

3496

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3497

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3498

{

3499

"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).

3500

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3501

},

3502

],

3503

"message": "A String", # [Output Only] A human-readable description of the warning code.

3504

},

3505

],

3506

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="update">update(project, region, urlMap, body=None, requestId=None)</code>

3512

<pre>Updates the specified UrlMap resource with the data included in the request.

3513

3514

Args:

3515

project: string, Project ID for this request. (required)

3516

region: string, Name of the region scoping this request. (required)

3517

urlMap: string, Name of the UrlMap resource to update. (required)

3518

body: object, The request body.

3519

The object takes the form of:

3520

3521

{ # Represents a URL Map resource.

3522

#

3523

# Google Compute Engine has two URL Map resources:

3524

#

3525

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3526

#

3527

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3528

#

3529

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3530

#

3531

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3532

#

3533

# 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.

3534

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3535

"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.

3536

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3537

"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

3538

"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.

3539

# Default is false.

3540

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3541

"A String",

3542

],

3543

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3544

"A String",

3545

],

3546

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3547

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3548

"A String",

3549

],

3550

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3551

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3552

"A String",

3553

],

3554

"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.

3555

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3556

"A String",

3557

],

3558

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3559

},

3560

"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.

3561

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3562

"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.

3563

"httpStatus": 42, # The HTTP status code used to abort the request.

3564

# The value must be between 200 and 599 inclusive.

3565

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3566

# The value must be between 0.0 and 100.0 inclusive.

3567

},

3568

"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.

3569

"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.

3570

"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.

3571

"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

3572

},

3573

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3574

# The value must be between 0.0 and 100.0 inclusive.

3575

},

3576

},

3577

"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.

3578

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3579

},

3580

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3581

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3582

"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.

3583

# 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.

3584

"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.

3585

"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

3586

},

3587

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3588

# - 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.

3589

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3590

# -

3591

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3592

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3593

# - 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.

3594

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3595

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3596

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3597

# - 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.

3602

# If not specified, will use the largest timeout among all backend services associated with the route.

3603

"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.

3604

"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

3605

},

3606

"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.

3607

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3608

# The value must be between 1 and 255 characters.

3609

"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.

3610

# The value must be between 1 and 1024 characters.

3611

},

3612

"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.

3613

# 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.

3614

{ # 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

3615

"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.

3616

"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.

3617

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3618

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3619

{ # Specification determining how headers are added to requests or responses.

3620

"headerName": "A String", # The name of the header.

3621

"headerValue": "A String", # The value of the header to add.

3622

"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.

3623

# The default value is false.

3624

},

3625

],

3626

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3627

"A String",

3628

],

3629

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3630

{ # Specification determining how headers are added to requests or responses.

3631

"headerName": "A String", # The name of the header.

3632

"headerValue": "A String", # The value of the header to add.

3633

"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.

3634

# The default value is false.

3635

},

3636

],

3637

"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) .

3642

# 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.

3643

# The value must be between 0 and 1000

},

],

},

"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.

3648

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3649

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3650

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3651

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3652

# The value must be between 1 and 255 characters.

3653

"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.

3654

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3655

# The default is set to false.

3656

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3657

# 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.

3658

# The value must be between 1 and 1024 characters.

3659

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3660

# 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.

3661

# The value must be between 1 and 1024 characters.

3662

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3663

# Supported values are:

3664

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3665

# - FOUND, which corresponds to 302.

3666

# - SEE_OTHER which corresponds to 303.

3667

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3668

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3669

"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.

3670

# The default is set to false.

3671

},

3672

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3673

"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.

3674

#

3675

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3676

"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.

3677

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3678

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3679

{ # Specification determining how headers are added to requests or responses.

3680

"headerName": "A String", # The name of the header.

3681

"headerValue": "A String", # The value of the header to add.

3682

"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.

3683

# The default value is false.

3684

},

3685

],

3686

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3687

"A String",

3688

],

3689

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3690

{ # Specification determining how headers are added to requests or responses.

3691

"headerName": "A String", # The name of the header.

3692

"headerValue": "A String", # The value of the header to add.

3693

"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.

3694

# The default value is false.

3695

},

3696

],

3697

"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.

3702

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3703

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3704

"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 ..

3705

"A String",

3706

],

3707

"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.

3708

},

3709

],

3710

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3711

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3712

"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.

3713

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3714

{ # 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.

3715

"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.

3716

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3717

"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

3718

"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.

3719

# Default is false.

3720

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3721

"A String",

3722

],

3723

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3724

"A String",

3725

],

3726

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3727

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3728

"A String",

3729

],

3730

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3731

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3732

"A String",

3733

],

3734

"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.

3735

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3736

"A String",

3737

],

3738

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3739

},

3740

"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.

3741

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3742

"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.

3743

"httpStatus": 42, # The HTTP status code used to abort the request.

3744

# The value must be between 200 and 599 inclusive.

3745

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3746

# The value must be between 0.0 and 100.0 inclusive.

3747

},

3748

"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.

3749

"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.

3750

"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.

3751

"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

3752

},

3753

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3754

# The value must be between 0.0 and 100.0 inclusive.

3755

},

3756

},

3757

"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.

3758

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3759

},

3760

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3761

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3762

"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.

3763

# 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.

3764

"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.

3765

"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

3766

},

3767

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3768

# - 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.

3769

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3770

# -

3771

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3772

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3773

# - 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.

3774

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3775

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3776

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3777

# - 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.

3782

# If not specified, will use the largest timeout among all backend services associated with the route.

3783

"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.

3784

"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

3785

},

3786

"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.

3787

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3788

# The value must be between 1 and 255 characters.

3789

"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.

3790

# The value must be between 1 and 1024 characters.

3791

},

3792

"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.

3793

# 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.

3794

{ # 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

3795

"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.

3796

"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.

3797

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3798

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3799

{ # Specification determining how headers are added to requests or responses.

3800

"headerName": "A String", # The name of the header.

3801

"headerValue": "A String", # The value of the header to add.

3802

"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.

3803

# The default value is false.

3804

},

3805

],

3806

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3807

"A String",

3808

],

3809

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3810

{ # Specification determining how headers are added to requests or responses.

3811

"headerName": "A String", # The name of the header.

3812

"headerValue": "A String", # The value of the header to add.

3813

"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.

3814

# The default value is false.

3815

},

3816

],

3817

"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) .

3822

# 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.

3823

# 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:

3828

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3829

# - compute/v1/projects/project/global/backendServices/backendService

3830

# - 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.

3831

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3832

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3833

# - compute.backendBuckets.use

3834

# - compute.backendServices.use

3835

"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.

3836

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3837

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3838

# The value must be between 1 and 255 characters.

3839

"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.

3840

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3841

# The default is set to false.

3842

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3843

# 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.

3844

# The value must be between 1 and 1024 characters.

3845

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3846

# 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.

3847

# The value must be between 1 and 1024 characters.

3848

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3849

# Supported values are:

3850

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3851

# - FOUND, which corresponds to 302.

3852

# - SEE_OTHER which corresponds to 303.

3853

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3854

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3855

"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.

3856

# The default is set to false.

3857

},

3858

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3859

"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.

3860

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3861

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3862

{ # Specification determining how headers are added to requests or responses.

3863

"headerName": "A String", # The name of the header.

3864

"headerValue": "A String", # The value of the header to add.

3865

"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.

3866

# The default value is false.

3867

},

3868

],

3869

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3870

"A String",

3871

],

3872

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3873

{ # Specification determining how headers are added to requests or responses.

3874

"headerName": "A String", # The name of the header.

3875

"headerValue": "A String", # The value of the header to add.

3876

"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.

3877

# The default value is false.

3878

},

3879

],

3880

"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.

3885

"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.

3886

# 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.

3887

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3888

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3889

"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.

3890

"A String",

3891

],

3892

"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.

3893

# Only one of routeAction or urlRedirect must be set.

3894

"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

3895

"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.

3896

# Default is false.

3897

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3898

"A String",

3899

],

3900

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3901

"A String",

3902

],

3903

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3904

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3905

"A String",

3906

],

3907

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3908

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3909

"A String",

3910

],

3911

"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.

3912

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3913

"A String",

3914

],

3915

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3916

},

3917

"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.

3918

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3919

"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.

3920

"httpStatus": 42, # The HTTP status code used to abort the request.

3921

# The value must be between 200 and 599 inclusive.

3922

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3923

# The value must be between 0.0 and 100.0 inclusive.

3924

},

3925

"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.

3926

"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.

3927

"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.

3928

"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

3929

},

3930

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3931

# The value must be between 0.0 and 100.0 inclusive.

3932

},

3933

},

3934

"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.

3935

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3936

},

3937

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3938

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3939

"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.

3940

# 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.

3941

"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.

3942

"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

3943

},

3944

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3945

# - 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.

3946

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3947

# -

3948

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3949

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3950

# - 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.

3951

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3952

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3953

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3954

# - 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.

3959

# If not specified, will use the largest timeout among all backend services associated with the route.

3960

"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.

3961

"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

3962

},

3963

"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.

3964

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3965

# The value must be between 1 and 255 characters.

3966

"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.

3967

# The value must be between 1 and 1024 characters.

3968

},

3969

"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.

3970

# 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.

3971

{ # 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

3972

"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.

3973

"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.

3974

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3975

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3976

{ # Specification determining how headers are added to requests or responses.

3977

"headerName": "A String", # The name of the header.

3978

"headerValue": "A String", # The value of the header to add.

3979

"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.

3980

# The default value is false.

3981

},

3982

],

3983

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3984

"A String",

3985

],

3986

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3987

{ # Specification determining how headers are added to requests or responses.

3988

"headerName": "A String", # The name of the header.

3989

"headerValue": "A String", # The value of the header to add.

3990

"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.

3991

# The default value is false.

3992

},

3993

],

3994

"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) .

3999

# 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.

4000

# 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.

4005

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4006

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4007

# If urlRedirect is specified, service or routeAction must not be set.

4008

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4009

# The value must be between 1 and 255 characters.

4010

"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.

4011

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4012

# The default is set to false.

4013

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4014

# 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.

4015

# The value must be between 1 and 1024 characters.

4016

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4017

# 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.

4018

# The value must be between 1 and 1024 characters.

4019

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4020

# Supported values are:

4021

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4022

# - FOUND, which corresponds to 302.

4023

# - SEE_OTHER which corresponds to 303.

4024

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4025

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4026

"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.

4027

# 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.

4032

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4033

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4034

"description": "A String", # The short description conveying the intent of this routeRule.

4035

# The description can have a maximum length of 1024 characters.

4036

"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.

4037

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4038

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4039

{ # Specification determining how headers are added to requests or responses.

4040

"headerName": "A String", # The name of the header.

4041

"headerValue": "A String", # The value of the header to add.

4042

"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.

4043

# The default value is false.

4044

},

4045

],

4046

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4047

"A String",

4048

],

4049

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4050

{ # Specification determining how headers are added to requests or responses.

4051

"headerName": "A String", # The name of the header.

4052

"headerValue": "A String", # The value of the header to add.

4053

"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.

4054

# The default value is false.

4055

},

4056

],

4057

"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.

4063

"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.

4064

# fullPathMatch must be between 1 and 1024 characters.

4065

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4066

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4067

{ # matchRule criteria for request header matches.

4068

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4069

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4070

"headerName": "A String", # The name of the HTTP header to match.

4071

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4072

# For matching a request's method, use the headerName ":method".

4073

"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.

4074

# The default setting is false.

4075

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4076

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4077

"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.

4078

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4079

"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.

4080

# For example for a range [-5, 0]

4081

# - -3 will match.

4082

# - 0 will not match.

4083

# - 0.25 will not match.

4084

# - -3someString will not match.

4085

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4086

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4087

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4088

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4089

},

4090

"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

4091

# 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.

4092

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4093

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4094

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4095

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4096

},

4097

],

4098

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4099

# The default value is false.

4100

# ignoreCase must not be used with regexMatch.

4101

"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.

4102

# 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.

4103

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4104

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4105

{ # 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.

4106

# 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.

4107

# 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.

4108

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4109

# This list must not be empty and can have at the most 64 entries.

4110

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4111

"name": "A String", # Name of metadata label.

4112

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4113

"value": "A String", # The value of the label must match the specified value.

4114

# value can have a maximum length of 1024 characters.

4115

},

4116

],

4117

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4118

# Supported values are:

4119

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4120

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4121

},

4122

],

4123

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4124

# The value must be between 1 and 1024 characters.

4125

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4126

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4127

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4128

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4129

# Only one of presentMatch, exactMatch or regexMatch must be set.

4130

"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.

4131

"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.

4132

# Only one of presentMatch, exactMatch or regexMatch must be set.

4133

"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

4134

# Only one of presentMatch, exactMatch or regexMatch must be set.

4135

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4136

},

4137

],

4138

"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

4139

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4140

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4141

},

4142

],

4143

"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.

4144

# 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.

4145

# 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.

4146

"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.

4147

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4148

"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

4149

"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.

4150

# Default is false.

4151

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4152

"A String",

4153

],

4154

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4155

"A String",

4156

],

4157

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4158

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4159

"A String",

4160

],

4161

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4162

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4163

"A String",

4164

],

4165

"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.

4166

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4167

"A String",

4168

],

4169

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4170

},

4171

"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.

4172

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4173

"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.

4174

"httpStatus": 42, # The HTTP status code used to abort the request.

4175

# The value must be between 200 and 599 inclusive.

4176

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4177

# The value must be between 0.0 and 100.0 inclusive.

4178

},

4179

"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.

4180

"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.

4181

"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.

4182

"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

4183

},

4184

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4185

# The value must be between 0.0 and 100.0 inclusive.

4186

},

4187

},

4188

"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.

4189

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4190

},

4191

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4192

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4193

"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.

4194

# 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.

4195

"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.

4196

"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

4197

},

4198

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4199

# - 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.

4200

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4201

# -

4202

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4203

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4204

# - 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.

4205

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4206

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4207

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4208

# - 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.

4213

# If not specified, will use the largest timeout among all backend services associated with the route.

4214

"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.

4215

"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

4216

},

4217

"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.

4218

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4219

# The value must be between 1 and 255 characters.

4220

"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.

4221

# The value must be between 1 and 1024 characters.

4222

},

4223

"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.

4224

# 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.

4225

{ # 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

4226

"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.

4227

"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.

4228

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4229

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4230

{ # Specification determining how headers are added to requests or responses.

4231

"headerName": "A String", # The name of the header.

4232

"headerValue": "A String", # The value of the header to add.

4233

"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.

4234

# The default value is false.

4235

},

4236

],

4237

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4238

"A String",

4239

],

4240

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4241

{ # Specification determining how headers are added to requests or responses.

4242

"headerName": "A String", # The name of the header.

4243

"headerValue": "A String", # The value of the header to add.

4244

"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.

4245

# The default value is false.

4246

},

4247

],

4248

"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) .

4253

# 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.

4254

# 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.

4259

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4260

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4261

# If urlRedirect is specified, service or routeAction must not be set.

4262

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4263

# The value must be between 1 and 255 characters.

4264

"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.

4265

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4266

# The default is set to false.

4267

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4268

# 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.

4269

# The value must be between 1 and 1024 characters.

4270

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4271

# 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.

4272

# The value must be between 1 and 1024 characters.

4273

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4274

# Supported values are:

4275

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4276

# - FOUND, which corresponds to 302.

4277

# - SEE_OTHER which corresponds to 303.

4278

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4279

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4280

"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.

4281

# 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.

4288

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4289

"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.

4290

{ # Message for the expected URL mappings.

4291

"description": "A String", # Description of this test case.

4292

"host": "A String", # Host portion of the URL.

4293

"path": "A String", # Path portion of the URL.

4294

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

},

],

}

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

4300

4301

Returns:

4302

An object of the form:

4303

4304

{ # Represents an Operation resource.

4305

#

4306

# Google Compute Engine has three Operation resources:

4307

#

4308

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4309

#

4310

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4311

#

4312

# Operations can be global, regional or zonal.

4313

# - For global operations, use the `globalOperations` resource.

4314

# - For regional operations, use the `regionOperations` resource.

4315

# - For zonal operations, use the `zonalOperations` resource.

4316

#

4317

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

4318

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4319

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4320

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4321

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4322

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4323

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

4324

{

4325

"code": "A String", # [Output Only] The error type identifier for this error.

4326

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4327

"message": "A String", # [Output Only] An optional, human-readable error message.

},

],

},

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4332

"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.

4333

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4334

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4335

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4336

"name": "A String", # [Output Only] Name of the operation.

4337

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4338

"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.

4339

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4340

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4341

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4342

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4343

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4344

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4345

"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.

4346

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4347

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4348

{

4349

"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.

4350

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4351

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4352

{

4353

"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).

4354

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4355

},

4356

],

4357

"message": "A String", # [Output Only] A human-readable description of the warning code.

4358

},

4359

],

4360

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

}</pre>

</div>

<code class="details" id="validate">validate(project, region, urlMap, body=None)</code>

4366

<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.

4367

4368

Args:

4369

project: string, Project ID for this request. (required)

4370

region: string, Name of the region scoping this request. (required)

4371

urlMap: string, Name of the UrlMap resource to be validated as. (required)

4372

body: object, The request body.

4373

The object takes the form of:

4374

4375

{

4376

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

4377

#

4378

# Google Compute Engine has two URL Map resources:

4379

#

4380

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4381

#

4382

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4383

#

4384

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4385

#

4386

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4387

#

4388

# 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.

4389

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4390

"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.

4391

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4392

"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

4393

"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.

4394

# Default is false.

4395

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4396

"A String",

4397

],

4398

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4399

"A String",

4400

],

4401

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4402

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4403

"A String",

4404

],

4405

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4406

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4407

"A String",

4408

],

4409

"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.

4410

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4411

"A String",

4412

],

4413

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4414

},

4415

"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.

4416

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4417

"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.

4418

"httpStatus": 42, # The HTTP status code used to abort the request.

4419

# The value must be between 200 and 599 inclusive.

4420

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4421

# The value must be between 0.0 and 100.0 inclusive.

4422

},

4423

"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.

4424

"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.

4425

"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.

4426

"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

4427

},

4428

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4429

# The value must be between 0.0 and 100.0 inclusive.

4430

},

4431

},

4432

"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.

4433

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4434

},

4435

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4436

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4437

"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.

4438

# 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.

4439

"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.

4440

"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

4441

},

4442

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4443

# - 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.

4444

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4445

# -

4446

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4447

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4448

# - 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.

4449

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4450

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4451

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4452

# - 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.

4457

# If not specified, will use the largest timeout among all backend services associated with the route.

4458

"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.

4459

"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

4460

},

4461

"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.

4462

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4463

# The value must be between 1 and 255 characters.

4464

"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.

4465

# The value must be between 1 and 1024 characters.

4466

},

4467

"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.

4468

# 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.

4469

{ # 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

4470

"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.

4471

"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.

4472

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4473

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4474

{ # Specification determining how headers are added to requests or responses.

4475

"headerName": "A String", # The name of the header.

4476

"headerValue": "A String", # The value of the header to add.

4477

"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.

4478

# The default value is false.

4479

},

4480

],

4481

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4482

"A String",

4483

],

4484

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4485

{ # Specification determining how headers are added to requests or responses.

4486

"headerName": "A String", # The name of the header.

4487

"headerValue": "A String", # The value of the header to add.

4488

"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.

4489

# The default value is false.

4490

},

4491

],

4492

"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) .

4497

# 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.

4498

# The value must be between 0 and 1000

},

],

},

"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.

4503

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4504

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4505

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4506

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4507

# The value must be between 1 and 255 characters.

4508

"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.

4509

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4510

# The default is set to false.

4511

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4512

# 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.

4513

# The value must be between 1 and 1024 characters.

4514

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4515

# 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.

4516

# The value must be between 1 and 1024 characters.

4517

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4518

# Supported values are:

4519

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4520

# - FOUND, which corresponds to 302.

4521

# - SEE_OTHER which corresponds to 303.

4522

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4523

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4524

"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.

4525

# The default is set to false.

4526

},

4527

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4528

"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.

4529

#

4530

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4531

"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.

4532

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4533

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4534

{ # Specification determining how headers are added to requests or responses.

4535

"headerName": "A String", # The name of the header.

4536

"headerValue": "A String", # The value of the header to add.

4537

"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.

4538

# The default value is false.

4539

},

4540

],

4541

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4542

"A String",

4543

],

4544

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4545

{ # Specification determining how headers are added to requests or responses.

4546

"headerName": "A String", # The name of the header.

4547

"headerValue": "A String", # The value of the header to add.

4548

"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.

4549

# The default value is false.

4550

},

4551

],

4552

"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.

4557

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4558

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4559

"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 ..

4560

"A String",

4561

],

4562

"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.

4563

},

4564

],

4565

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4566

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4567

"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.

4568

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4569

{ # 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.

4570

"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.

4571

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4572

"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

4573

"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.

4574

# Default is false.

4575

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4576

"A String",

4577

],

4578

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4579

"A String",

4580

],

4581

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4582

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4583

"A String",

4584

],

4585

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4586

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4587

"A String",

4588

],

4589

"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.

4590

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4591

"A String",

4592

],

4593

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4594

},

4595

"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.

4596

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4597

"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.

4598

"httpStatus": 42, # The HTTP status code used to abort the request.

4599

# The value must be between 200 and 599 inclusive.

4600

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4601

# The value must be between 0.0 and 100.0 inclusive.

4602

},

4603

"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.

4604

"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.

4605

"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.

4606

"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

4607

},

4608

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4609

# The value must be between 0.0 and 100.0 inclusive.

4610

},

4611

},

4612

"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.

4613

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4614

},

4615

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4616

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4617

"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.

4618

# 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.

4619

"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.

4620

"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

4621

},

4622

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4623

# - 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.

4624

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4625

# -

4626

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4627

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4628

# - 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.

4629

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4630

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4631

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4632

# - 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.

4637

# If not specified, will use the largest timeout among all backend services associated with the route.

4638

"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.

4639

"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

4640

},

4641

"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.

4642

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4643

# The value must be between 1 and 255 characters.

4644

"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.

4645

# The value must be between 1 and 1024 characters.

4646

},

4647

"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.

4648

# 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.

4649

{ # 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

4650

"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.

4651

"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.

4652

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4653

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4654

{ # Specification determining how headers are added to requests or responses.

4655

"headerName": "A String", # The name of the header.

4656

"headerValue": "A String", # The value of the header to add.

4657

"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.

4658

# The default value is false.

4659

},

4660

],

4661

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4662

"A String",

4663

],

4664

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4665

{ # Specification determining how headers are added to requests or responses.

4666

"headerName": "A String", # The name of the header.

4667

"headerValue": "A String", # The value of the header to add.

4668

"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.

4669

# The default value is false.

4670

},

4671

],

4672

"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) .

4677

# 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.

4678

# 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:

4683

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4684

# - compute/v1/projects/project/global/backendServices/backendService

4685

# - 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.

4686

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4687

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4688

# - compute.backendBuckets.use

4689

# - compute.backendServices.use

4690

"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.

4691

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4692

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4693

# The value must be between 1 and 255 characters.

4694

"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.

4695

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4696

# The default is set to false.

4697

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4698

# 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.

4699

# The value must be between 1 and 1024 characters.

4700

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4701

# 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.

4702

# The value must be between 1 and 1024 characters.

4703

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4704

# Supported values are:

4705

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4706

# - FOUND, which corresponds to 302.

4707

# - SEE_OTHER which corresponds to 303.

4708

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4709

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4710

"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.

4711

# The default is set to false.

4712

},

4713

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4714

"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.

4715

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4716

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4717

{ # Specification determining how headers are added to requests or responses.

4718

"headerName": "A String", # The name of the header.

4719

"headerValue": "A String", # The value of the header to add.

4720

"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.

4721

# The default value is false.

4722

},

4723

],

4724

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4725

"A String",

4726

],

4727

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4728

{ # Specification determining how headers are added to requests or responses.

4729

"headerName": "A String", # The name of the header.

4730

"headerValue": "A String", # The value of the header to add.

4731

"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.

4732

# The default value is false.

4733

},

4734

],

4735

"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.

4740

"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.

4741

# 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.

4742

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4743

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4744

"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.

4745

"A String",

4746

],

4747

"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.

4748

# Only one of routeAction or urlRedirect must be set.

4749

"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

4750

"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.

4751

# Default is false.

4752

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4753

"A String",

4754

],

4755

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4756

"A String",

4757

],

4758

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4759

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4760

"A String",

4761

],

4762

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4763

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4764

"A String",

4765

],

4766

"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.

4767

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4768

"A String",

4769

],

4770

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4771

},

4772

"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.

4773

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4774

"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.

4775

"httpStatus": 42, # The HTTP status code used to abort the request.

4776

# The value must be between 200 and 599 inclusive.

4777

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4778

# The value must be between 0.0 and 100.0 inclusive.

4779

},

4780

"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.

4781

"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.

4782

"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.

4783

"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

4784

},

4785

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4786

# The value must be between 0.0 and 100.0 inclusive.

4787

},

4788

},

4789

"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.

4790

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4791

},

4792

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4793

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4794

"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.

4795

# 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.

4796

"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.

4797

"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

4798

},

4799

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4800

# - 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.

4801

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4802

# -

4803

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4804

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4805

# - 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.

4806

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4807

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4808

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4809

# - 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.

4814

# If not specified, will use the largest timeout among all backend services associated with the route.

4815

"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.

4816

"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

4817

},

4818

"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.

4819

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4820

# The value must be between 1 and 255 characters.

4821

"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.

4822

# The value must be between 1 and 1024 characters.

4823

},

4824

"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.

4825

# 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.

4826

{ # 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

4827

"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.

4828

"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.

4829

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4830

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4831

{ # Specification determining how headers are added to requests or responses.

4832

"headerName": "A String", # The name of the header.

4833

"headerValue": "A String", # The value of the header to add.

4834

"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.

4835

# The default value is false.

4836

},

4837

],

4838

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4839

"A String",

4840

],

4841

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4842

{ # Specification determining how headers are added to requests or responses.

4843

"headerName": "A String", # The name of the header.

4844

"headerValue": "A String", # The value of the header to add.

4845

"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.

4846

# The default value is false.

4847

},

4848

],

4849

"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) .

4854

# 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.

4855

# 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.

4860

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4861

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4862

# If urlRedirect is specified, service or routeAction must not be set.

4863

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4864

# The value must be between 1 and 255 characters.

4865

"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.

4866

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4867

# The default is set to false.

4868

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4869

# 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.

4870

# The value must be between 1 and 1024 characters.

4871

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4872

# 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.

4873

# The value must be between 1 and 1024 characters.

4874

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4875

# Supported values are:

4876

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4877

# - FOUND, which corresponds to 302.

4878

# - SEE_OTHER which corresponds to 303.

4879

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4880

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4881

"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.

4882

# 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.

4887

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4888

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4889

"description": "A String", # The short description conveying the intent of this routeRule.

4890

# The description can have a maximum length of 1024 characters.

4891

"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.

4892

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4893

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4894

{ # Specification determining how headers are added to requests or responses.

4895

"headerName": "A String", # The name of the header.

4896

"headerValue": "A String", # The value of the header to add.

4897

"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.

4898

# The default value is false.

4899

},

4900

],

4901

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4902

"A String",

4903

],

4904

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4905

{ # Specification determining how headers are added to requests or responses.

4906

"headerName": "A String", # The name of the header.

4907

"headerValue": "A String", # The value of the header to add.

4908

"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.

4909

# The default value is false.

4910

},

4911

],

4912

"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.

4918

"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.

4919

# fullPathMatch must be between 1 and 1024 characters.

4920

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4921

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4922

{ # matchRule criteria for request header matches.

4923

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4924

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4925

"headerName": "A String", # The name of the HTTP header to match.

4926

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4927

# For matching a request's method, use the headerName ":method".

4928

"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.

4929

# The default setting is false.

4930

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4931

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4932

"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.

4933

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4934

"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.

4935

# For example for a range [-5, 0]

4936

# - -3 will match.

4937

# - 0 will not match.

4938

# - 0.25 will not match.

4939

# - -3someString will not match.

4940

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4941

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4942

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4943

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4944

},

4945

"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

4946

# 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.

4947

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4948

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4949

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4950

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4951

},

4952

],

4953

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4954

# The default value is false.

4955

# ignoreCase must not be used with regexMatch.

4956

"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.

4957

# 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.

4958

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4959

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4960

{ # 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.

4961

# 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.

4962

# 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.

4963

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4964

# This list must not be empty and can have at the most 64 entries.

4965

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4966

"name": "A String", # Name of metadata label.

4967

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4968

"value": "A String", # The value of the label must match the specified value.

4969

# value can have a maximum length of 1024 characters.

4970

},

4971

],

4972

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4973

# Supported values are:

4974

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4975

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4976

},

4977

],

4978

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4979

# The value must be between 1 and 1024 characters.

4980

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4981

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4982

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4983

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4984

# Only one of presentMatch, exactMatch or regexMatch must be set.

4985

"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.

4986

"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.

4987

# Only one of presentMatch, exactMatch or regexMatch must be set.

4988

"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

4989

# Only one of presentMatch, exactMatch or regexMatch must be set.

4990

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4991

},

4992

],

4993

"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

4994

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4995

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4996

},

4997

],

4998

"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.

4999

# 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.

5000

# 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.

5001

"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.

5002

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5003

"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

5004

"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.

5005

# Default is false.

5006

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5007

"A String",

5008

],

5009

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5010

"A String",

5011

],

5012

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5013

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5014

"A String",

5015

],

5016

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5017

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5018

"A String",

5019

],

5020

"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.

5021

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5022

"A String",

5023

],

5024

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5025

},

5026

"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.

5027

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5028

"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.

5029

"httpStatus": 42, # The HTTP status code used to abort the request.

5030

# The value must be between 200 and 599 inclusive.

5031

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5032

# The value must be between 0.0 and 100.0 inclusive.

5033

},

5034

"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.

5035

"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.

5036

"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.

5037

"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

5038

},

5039

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5040

# The value must be between 0.0 and 100.0 inclusive.

5041

},

5042

},

5043

"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.

5044

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5045

},

5046

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5047

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5048

"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.

5049

# 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.

5050

"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.

5051

"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

5052

},

5053

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5054

# - 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.

5055

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5056

# -

5057

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5058

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5059

# - 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.

5060

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5061

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5062

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5063

# - 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.

5068

# If not specified, will use the largest timeout among all backend services associated with the route.

5069

"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.

5070

"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

5071

},

5072

"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.

5073

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5074

# The value must be between 1 and 255 characters.

5075

"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.

5076

# The value must be between 1 and 1024 characters.

5077

},

5078

"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.

5079

# 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.

5080

{ # 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

5081

"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.

5082

"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.

5083

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5084

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5085

{ # Specification determining how headers are added to requests or responses.

5086

"headerName": "A String", # The name of the header.

5087

"headerValue": "A String", # The value of the header to add.

5088

"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.

5089

# The default value is false.

5090

},

5091

],

5092

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5093

"A String",

5094

],

5095

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5096

{ # Specification determining how headers are added to requests or responses.

5097

"headerName": "A String", # The name of the header.

5098

"headerValue": "A String", # The value of the header to add.

5099

"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.

5100

# The default value is false.

5101

},

5102

],

5103

"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) .

5108

# 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.

5109

# 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.

5114

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5115

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5116

# If urlRedirect is specified, service or routeAction must not be set.

5117

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5118

# The value must be between 1 and 255 characters.

5119

"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.

5120

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5121

# The default is set to false.

5122

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5123

# 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.

5124

# The value must be between 1 and 1024 characters.

5125

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5126

# 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.

5127

# The value must be between 1 and 1024 characters.

5128

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5129

# Supported values are:

5130

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5131

# - FOUND, which corresponds to 302.

5132

# - SEE_OTHER which corresponds to 303.

5133

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5134

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5135

"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.

5136

# 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.

5143

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5144

"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.

5145

{ # Message for the expected URL mappings.

5146

"description": "A String", # Description of this test case.

5147

"host": "A String", # Host portion of the URL.

5148

"path": "A String", # Path portion of the URL.

5149

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

},

],

},

}

Returns:

An object of the form:

5158

5159

{

5160

"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.

5165

"testFailures": [

5166

{

5167

"actualService": "A String",

5168

"expectedService": "A String",

"host": "A String",

"path": "A String",

},

],

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

},

}</pre>

</div>

</body></html>