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

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

<h3>Method Details</h3>

108

109

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

110

<pre>Deletes the specified UrlMap resource.

111

112

Args:

113

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

114

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

115

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

116

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

117

118

Returns:

119

An object of the form:

120

121

{ # Represents an Operation resource.

122

#

Dan O'Meara

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

[diff] [blame]

123

# Google Compute Engine has three Operation resources:

124

#

125

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

126

#

Bu Sun Kim

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

[diff] [blame]

127

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

128

#

129

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

130

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

131

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

132

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

Bu Sun Kim

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

[diff] [blame]

133

#

Dan O'Meara

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

[diff] [blame]

134

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

Bu Sun Kim

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

[diff] [blame]

135

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

136

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

137

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

138

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

139

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

140

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

Bu Sun Kim

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

[diff] [blame]

141

{

Bu Sun Kim

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

[diff] [blame]

142

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

143

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

144

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

Bu Sun Kim

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

[diff] [blame]

145

},

146

],

147

},

Bu Sun Kim

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

[diff] [blame]

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

159

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

160

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

161

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

162

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

163

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

164

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

165

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

166

{

167

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

168

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

169

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

170

{

171

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

172

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

173

},

174

],

175

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

176

},

177

],

178

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

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

184

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

185

186

Args:

187

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

188

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

189

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

190

191

Returns:

192

An object of the form:

193

Dan O'Meara

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

[diff] [blame]

194

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

195

#

196

# Google Compute Engine has two URL Map resources:

197

#

198

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

199

#

200

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

201

#

202

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

203

#

204

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

205

#

206

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

207

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

208

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

209

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

210

"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

211

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

212

# Default is false.

213

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

214

"A String",

Bu Sun Kim

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

[diff] [blame]

215

],

Bu Sun Kim

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

[diff] [blame]

216

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

217

"A String",

218

],

219

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

220

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

221

"A String",

222

],

223

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

224

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

225

"A String",

226

],

227

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

228

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

229

"A String",

230

],

231

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

232

},

233

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

234

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

235

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

236

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

237

# The value must be between 200 and 599 inclusive.

238

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

239

# The value must be between 0.0 and 100.0 inclusive.

240

},

241

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

242

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

243

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

244

"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

245

},

246

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

247

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

248

},

249

},

Bu Sun Kim

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

[diff] [blame]

250

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

251

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

252

},

253

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

254

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

255

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

256

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

257

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

258

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

Bu Sun Kim

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

[diff] [blame]

259

},

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

262

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

263

# -

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

"A String",

Bu Sun Kim

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

[diff] [blame]

272

],

273

},

Bu Sun Kim

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

[diff] [blame]

274

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

275

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

276

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

277

"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

278

},

279

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

280

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

Bu Sun Kim

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

[diff] [blame]

281

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

282

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

283

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

284

},

Bu Sun Kim

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

[diff] [blame]

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

# The default value is false.

297

},

298

],

299

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

300

"A String",

301

],

302

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

303

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

304

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

305

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

306

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

307

# The default value is false.

308

},

309

],

310

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

315

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

316

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

317

},

318

],

Bu Sun Kim

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

[diff] [blame]

319

},

320

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

321

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

322

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

323

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

324

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

325

# The value must be between 1 and 255 characters.

326

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

327

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

328

# The default is set to false.

329

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

330

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

331

# The value must be between 1 and 1024 characters.

332

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

333

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

334

# The value must be between 1 and 1024 characters.

335

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

336

# Supported values are:

337

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

338

# - FOUND, which corresponds to 302.

339

# - SEE_OTHER which corresponds to 303.

340

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

341

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

342

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

343

# The default is set to false.

344

},

345

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

346

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

347

#

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

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

356

# The default value is false.

357

},

358

],

359

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

360

"A String",

361

],

362

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

363

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

364

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

365

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

366

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

367

# The default value is false.

368

},

369

],

370

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

375

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

376

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

377

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

378

"A String",

379

],

380

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

381

},

382

],

383

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

384

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

385

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

386

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

387

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

388

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

389

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

390

"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

391

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

392

# Default is false.

393

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

394

"A String",

395

],

396

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

397

"A String",

398

],

399

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

400

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

401

"A String",

402

],

403

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

404

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

405

"A String",

406

],

407

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

408

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

409

"A String",

410

],

411

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

412

},

413

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

414

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

415

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

416

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

417

# The value must be between 200 and 599 inclusive.

418

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

419

# The value must be between 0.0 and 100.0 inclusive.

420

},

421

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

422

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

423

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

424

"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

425

},

426

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

427

# The value must be between 0.0 and 100.0 inclusive.

428

},

429

},

430

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

431

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

432

},

433

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

434

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

435

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

436

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

437

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

438

"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

439

},

440

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

441

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

442

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

443

# -

444

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

445

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

446

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

447

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

448

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

449

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

450

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

455

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

456

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

457

"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

458

},

459

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

460

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

461

# The value must be between 1 and 255 characters.

462

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

463

# The value must be between 1 and 1024 characters.

464

},

465

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

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

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

474

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

475

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

476

# The default value is false.

477

},

478

],

479

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

480

"A String",

481

],

482

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

483

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

484

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

485

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

486

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

487

# The default value is false.

488

},

489

],

490

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

"A String",

],

},

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

495

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

496

# The value must be between 0 and 1000

},

],

},

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

501

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

502

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

503

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

504

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

505

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

506

# - compute.backendBuckets.use

507

# - compute.backendServices.use

508

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

509

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

510

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

511

# The value must be between 1 and 255 characters.

512

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

513

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

514

# The default is set to false.

515

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

516

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

517

# The value must be between 1 and 1024 characters.

518

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

519

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

520

# The value must be between 1 and 1024 characters.

521

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

522

# Supported values are:

523

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

524

# - FOUND, which corresponds to 302.

525

# - SEE_OTHER which corresponds to 303.

526

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

527

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

528

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

529

# The default is set to false.

530

},

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

# The default value is false.

540

},

541

],

542

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

543

"A String",

544

],

545

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

546

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

547

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

548

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

549

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

550

# The default value is false.

551

},

552

],

553

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

"A String",

],

},

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

558

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

559

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

560

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

561

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

562

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

563

"A String",

564

],

565

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

566

# Only one of routeAction or urlRedirect must be set.

567

"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

568

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

569

# Default is false.

570

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

571

"A String",

572

],

573

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

574

"A String",

575

],

576

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

577

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

578

"A String",

579

],

580

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

581

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

582

"A String",

583

],

584

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

585

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

586

"A String",

587

],

588

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

589

},

590

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

591

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

592

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

593

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

594

# The value must be between 200 and 599 inclusive.

595

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

596

# The value must be between 0.0 and 100.0 inclusive.

597

},

598

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

599

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

600

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

601

"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

602

},

603

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

604

# The value must be between 0.0 and 100.0 inclusive.

605

},

606

},

607

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

608

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

609

},

610

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

611

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

612

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

613

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

614

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

615

"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

616

},

617

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

618

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

619

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

620

# -

621

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

622

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

623

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

624

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

625

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

626

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

627

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

632

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

633

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

634

"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

635

},

636

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

637

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

638

# The value must be between 1 and 255 characters.

639

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

640

# The value must be between 1 and 1024 characters.

641

},

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

# The default value is false.

654

},

655

],

656

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

657

"A String",

658

],

659

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

660

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

661

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

662

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

663

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

664

# The default value is false.

665

},

666

],

667

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

672

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

673

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

678

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

679

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

680

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

681

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

682

# The value must be between 1 and 255 characters.

683

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

684

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

685

# The default is set to false.

686

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

687

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

688

# The value must be between 1 and 1024 characters.

689

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

690

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

691

# The value must be between 1 and 1024 characters.

692

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

693

# Supported values are:

694

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

695

# - FOUND, which corresponds to 302.

696

# - SEE_OTHER which corresponds to 303.

697

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

698

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

699

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

700

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

705

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

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

# The default value is false.

717

},

718

],

719

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

720

"A String",

721

],

722

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

723

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

724

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

725

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

726

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

727

# The default value is false.

728

},

729

],

730

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

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

735

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

736

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

737

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

738

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

739

},

740

],

741

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

742

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

743

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

744

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

745

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

746

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

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

751

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

752

# fullPathMatch must be between 1 and 1024 characters.

753

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

754

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

755

{ # matchRule criteria for request header matches.

756

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

757

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

758

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

759

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

760

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

761

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

762

# The default setting is false.

763

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

764

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

765

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

766

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

767

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

768

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

769

# - -3 will match.

770

# - 0 will not match.

771

# - 0.25 will not match.

772

# - -3someString will not match.

773

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

774

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

775

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

776

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

777

},

778

"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

779

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

780

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

781

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

782

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

783

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

784

},

785

],

786

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

787

# The default value is false.

788

# ignoreCase must not be used with regexMatch.

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

# value can have a maximum length of 1024 characters.

803

},

804

],

805

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

806

# Supported values are:

807

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

808

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

809

},

810

],

811

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

812

# The value must be between 1 and 1024 characters.

813

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

814

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

815

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

816

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

817

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

818

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

819

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

820

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

821

"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

822

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

823

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

824

},

825

],

826

"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

827

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

828

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

829

},

830

],

831

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

832

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

833

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

834

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

835

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

836

"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

837

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

838

# Default is false.

839

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

840

"A String",

841

],

842

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

843

"A String",

844

],

845

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

846

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

847

"A String",

848

],

849

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

850

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

851

"A String",

852

],

853

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

854

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

855

"A String",

856

],

857

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

858

},

859

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

860

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

861

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

862

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

863

# The value must be between 200 and 599 inclusive.

864

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

865

# The value must be between 0.0 and 100.0 inclusive.

866

},

867

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

868

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

869

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

870

"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

871

},

872

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

873

# The value must be between 0.0 and 100.0 inclusive.

874

},

875

},

876

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

877

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

878

},

879

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

880

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

881

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

882

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

883

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

884

"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

885

},

886

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

887

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

888

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

889

# -

890

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

891

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

892

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

893

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

894

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

895

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

896

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

901

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

902

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

903

"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

904

},

905

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

906

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

907

# The value must be between 1 and 255 characters.

908

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

909

# The value must be between 1 and 1024 characters.

910

},

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

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

920

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

921

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

922

# The default value is false.

923

},

924

],

925

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

926

"A String",

927

],

928

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

929

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

930

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

931

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

932

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

933

# The default value is false.

934

},

935

],

936

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

941

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

942

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

947

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

948

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

949

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

950

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

951

# The value must be between 1 and 255 characters.

952

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

953

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

954

# The default is set to false.

955

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

956

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

957

# The value must be between 1 and 1024 characters.

958

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

959

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

960

# The value must be between 1 and 1024 characters.

961

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

962

# Supported values are:

963

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

964

# - FOUND, which corresponds to 302.

965

# - SEE_OTHER which corresponds to 303.

966

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

967

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

968

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

969

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

976

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

977

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

978

{ # Message for the expected URL mappings.

979

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

980

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

981

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

982

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

983

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

984

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

985

},

986

],

987

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

991

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

Bu Sun Kim

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

[diff] [blame]

992

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

993

994

Args:

995

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

996

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

Dan O'Meara

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

[diff] [blame]

997

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

998

The object takes the form of:

999

Dan O'Meara

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

[diff] [blame]

1000

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1001

#

1002

# Google Compute Engine has two URL Map resources:

1003

#

1004

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

1005

#

1006

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

1007

#

1008

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

1009

#

1010

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

1011

#

1012

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

1013

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

1014

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

1015

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1016

"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

1017

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

1018

# Default is false.

1019

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

1020

"A String",

Bu Sun Kim

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

[diff] [blame]

1021

],

Bu Sun Kim

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

[diff] [blame]

1022

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

1023

"A String",

1024

],

1025

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

1026

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

1027

"A String",

1028

],

1029

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

1030

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

1031

"A String",

1032

],

1033

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

1034

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

1035

"A String",

1036

],

1037

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

1038

},

1039

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

1040

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

1041

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

1042

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

1043

# The value must be between 200 and 599 inclusive.

1044

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

1045

# The value must be between 0.0 and 100.0 inclusive.

1046

},

1047

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

1048

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

1049

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

1050

"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

1051

},

1052

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

1053

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1054

},

1055

},

Bu Sun Kim

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

[diff] [blame]

1056

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

1057

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

1058

},

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

Bu Sun Kim

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

[diff] [blame]

1065

},

Bu Sun Kim

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

[diff] [blame]

1066

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

1067

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

1068

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

1069

# -

1070

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

1071

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

1072

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

1073

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

1074

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

1075

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

1076

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

1077

"A String",

Bu Sun Kim

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

[diff] [blame]

1078

],

1079

},

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

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

1082

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

1083

"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

1084

},

1085

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

1086

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

Bu Sun Kim

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

[diff] [blame]

1087

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1088

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

1089

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1090

},

Bu Sun Kim

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

[diff] [blame]

1091

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

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

# The default value is false.

1103

},

1104

],

1105

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

1106

"A String",

1107

],

1108

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

1109

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

1110

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

1111

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

1112

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

1113

# The default value is false.

1114

},

1115

],

1116

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

1121

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

1122

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

1123

},

1124

],

Bu Sun Kim

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

[diff] [blame]

1125

},

1126

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

1127

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

1128

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

1129

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

1130

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

1131

# The value must be between 1 and 255 characters.

1132

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

1133

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

1134

# The default is set to false.

1135

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

1136

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

1137

# The value must be between 1 and 1024 characters.

1138

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

1139

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

1140

# The value must be between 1 and 1024 characters.

1141

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

1142

# Supported values are:

1143

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

1144

# - FOUND, which corresponds to 302.

1145

# - SEE_OTHER which corresponds to 303.

1146

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

1147

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

1148

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

1149

# The default is set to false.

1150

},

1151

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

1152

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

1153

#

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

# The default value is false.

1163

},

1164

],

1165

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

1166

"A String",

1167

],

1168

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

1169

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

1170

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

1171

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

1172

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

1173

# The default value is false.

1174

},

1175

],

1176

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

1181

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

1182

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

1183

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

1184

"A String",

1185

],

1186

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

1187

},

1188

],

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1196

"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

1197

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

1198

# Default is false.

1199

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

1200

"A String",

1201

],

1202

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

1203

"A String",

1204

],

1205

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

1206

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

1207

"A String",

1208

],

1209

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

1210

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

1211

"A String",

1212

],

1213

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

1214

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

1215

"A String",

1216

],

1217

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

1218

},

1219

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

1220

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

1221

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

1222

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

1223

# The value must be between 200 and 599 inclusive.

1224

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

1225

# The value must be between 0.0 and 100.0 inclusive.

1226

},

1227

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

1228

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

1229

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

1230

"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

1231

},

1232

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

1233

# The value must be between 0.0 and 100.0 inclusive.

1234

},

1235

},

1236

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

1237

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

1238

},

1239

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

1240

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

1241

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

1242

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

1243

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

1244

"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

1245

},

1246

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

1247

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

1248

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

1249

# -

1250

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

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1261

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

1262

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

1263

"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

1264

},

1265

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

1266

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

1267

# The value must be between 1 and 255 characters.

1268

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

1269

# The value must be between 1 and 1024 characters.

1270

},

1271

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

1272

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

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

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

1280

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

1281

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

1282

# The default value is false.

1283

},

1284

],

1285

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

1286

"A String",

1287

],

1288

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

1289

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

1290

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

1291

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

1292

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

1293

# The default value is false.

1294

},

1295

],

1296

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

1301

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

1302

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

1307

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

1308

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

1309

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

1310

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

1311

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

1312

# - compute.backendBuckets.use

1313

# - compute.backendServices.use

1314

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

1315

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

1316

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

1317

# The value must be between 1 and 255 characters.

1318

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

1319

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

1320

# The default is set to false.

1321

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

1322

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

1323

# The value must be between 1 and 1024 characters.

1324

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

1325

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

1326

# The value must be between 1 and 1024 characters.

1327

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

1328

# Supported values are:

1329

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

1330

# - FOUND, which corresponds to 302.

1331

# - SEE_OTHER which corresponds to 303.

1332

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

1333

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

1334

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

1335

# The default is set to false.

1336

},

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

# The default value is false.

1346

},

1347

],

1348

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

1349

"A String",

1350

],

1351

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

1352

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

1353

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

1354

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

1355

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

1356

# The default value is false.

1357

},

1358

],

1359

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

1364

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

1365

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

1366

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

1367

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

1368

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

1369

"A String",

1370

],

1371

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

1372

# Only one of routeAction or urlRedirect must be set.

1373

"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

1374

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

1375

# Default is false.

1376

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

1377

"A String",

1378

],

1379

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

1380

"A String",

1381

],

1382

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

1383

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

1384

"A String",

1385

],

1386

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

1387

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

1388

"A String",

1389

],

1390

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

1391

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

1392

"A String",

1393

],

1394

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

1395

},

1396

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

1397

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

1398

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

1399

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

1400

# The value must be between 200 and 599 inclusive.

1401

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

1402

# The value must be between 0.0 and 100.0 inclusive.

1403

},

1404

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

1405

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

1406

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

1407

"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

1408

},

1409

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

1410

# The value must be between 0.0 and 100.0 inclusive.

1411

},

1412

},

1413

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

1414

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

1415

},

1416

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1417

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1418

"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.

1419

# 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.

1420

"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.

1421

"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

1422

},

1423

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1424

# - 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.

1425

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1426

# -

1427

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1428

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1429

# - 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.

1430

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1431

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1432

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1433

# - 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.

1438

# If not specified, will use the largest timeout among all backend services associated with the route.

1439

"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.

1440

"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

1441

},

1442

"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.

1443

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1444

# The value must be between 1 and 255 characters.

1445

"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.

1446

# The value must be between 1 and 1024 characters.

1447

},

1448

"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.

1449

# 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.

1450

{ # 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

1451

"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.

1452

"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.

1453

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1454

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1455

{ # Specification determining how headers are added to requests or responses.

1456

"headerName": "A String", # The name of the header.

1457

"headerValue": "A String", # The value of the header to add.

1458

"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.

1459

# The default value is false.

1460

},

1461

],

1462

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1463

"A String",

1464

],

1465

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1466

{ # Specification determining how headers are added to requests or responses.

1467

"headerName": "A String", # The name of the header.

1468

"headerValue": "A String", # The value of the header to add.

1469

"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.

1470

# The default value is false.

1471

},

1472

],

1473

"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) .

1478

# 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.

1479

# 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.

1484

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1485

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1486

# If urlRedirect is specified, service or routeAction must not be set.

1487

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1488

# The value must be between 1 and 255 characters.

1489

"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.

1490

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1491

# The default is set to false.

1492

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1493

# 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.

1494

# The value must be between 1 and 1024 characters.

1495

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1496

# 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.

1497

# The value must be between 1 and 1024 characters.

1498

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1499

# Supported values are:

1500

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1501

# - FOUND, which corresponds to 302.

1502

# - SEE_OTHER which corresponds to 303.

1503

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1504

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1505

"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.

1506

# 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.

1511

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1512

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1513

"description": "A String", # The short description conveying the intent of this routeRule.

1514

# The description can have a maximum length of 1024 characters.

1515

"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.

1516

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1517

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1518

{ # Specification determining how headers are added to requests or responses.

1519

"headerName": "A String", # The name of the header.

1520

"headerValue": "A String", # The value of the header to add.

1521

"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.

1522

# The default value is false.

1523

},

1524

],

1525

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1526

"A String",

1527

],

1528

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1529

{ # Specification determining how headers are added to requests or responses.

1530

"headerName": "A String", # The name of the header.

1531

"headerValue": "A String", # The value of the header to add.

1532

"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.

1533

# The default value is false.

1534

},

1535

],

1536

"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",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1541

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1542

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1543

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1544

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

1545

},

1546

],

1547

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1548

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

1549

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1550

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1551

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1552

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1557

"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.

1558

# fullPathMatch must be between 1 and 1024 characters.

1559

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1560

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1561

{ # matchRule criteria for request header matches.

1562

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1563

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1564

"headerName": "A String", # The name of the HTTP header to match.

1565

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1566

# For matching a request's method, use the headerName ":method".

1567

"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.

1568

# The default setting is false.

1569

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1570

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1571

"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.

1572

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1573

"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.

1574

# For example for a range [-5, 0]

1575

# - -3 will match.

1576

# - 0 will not match.

1577

# - 0.25 will not match.

1578

# - -3someString will not match.

1579

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1580

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1581

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1582

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1583

},

1584

"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

1585

# 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.

1586

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1587

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1588

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1589

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1590

},

1591

],

1592

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1593

# The default value is false.

1594

# ignoreCase must not be used with regexMatch.

1595

"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.

1596

# 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.

1597

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1598

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1599

{ # 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.

1600

# 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.

1601

# 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.

1602

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1603

# This list must not be empty and can have at the most 64 entries.

1604

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1605

"name": "A String", # Name of metadata label.

1606

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1607

"value": "A String", # The value of the label must match the specified value.

1608

# value can have a maximum length of 1024 characters.

1609

},

1610

],

1611

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1612

# Supported values are:

1613

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1614

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1615

},

1616

],

1617

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1618

# The value must be between 1 and 1024 characters.

1619

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1620

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1621

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1622

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1623

# Only one of presentMatch, exactMatch or regexMatch must be set.

1624

"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.

1625

"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.

1626

# Only one of presentMatch, exactMatch or regexMatch must be set.

1627

"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

1628

# Only one of presentMatch, exactMatch or regexMatch must be set.

1629

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1630

},

1631

],

1632

"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

1633

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1634

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1635

},

1636

],

1637

"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.

1638

# 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.

1639

# 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.

1640

"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.

1641

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1642

"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

1643

"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.

1644

# Default is false.

1645

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1646

"A String",

1647

],

1648

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1649

"A String",

1650

],

1651

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1652

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1653

"A String",

1654

],

1655

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1656

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1657

"A String",

1658

],

1659

"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.

1660

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1661

"A String",

1662

],

1663

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1664

},

1665

"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.

1666

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1667

"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.

1668

"httpStatus": 42, # The HTTP status code used to abort the request.

1669

# The value must be between 200 and 599 inclusive.

1670

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1671

# The value must be between 0.0 and 100.0 inclusive.

1672

},

1673

"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.

1674

"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.

1675

"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.

1676

"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

1677

},

1678

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1679

# The value must be between 0.0 and 100.0 inclusive.

1680

},

1681

},

1682

"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.

1683

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1684

},

1685

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1686

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1687

"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.

1688

# 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.

1689

"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.

1690

"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

1691

},

1692

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1693

# - 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.

1694

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1695

# -

1696

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1697

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1698

# - 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.

1699

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1700

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1701

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1702

# - 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.

1707

# If not specified, will use the largest timeout among all backend services associated with the route.

1708

"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.

1709

"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

1710

},

1711

"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.

1712

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1713

# The value must be between 1 and 255 characters.

1714

"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.

1715

# The value must be between 1 and 1024 characters.

1716

},

1717

"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.

1718

# 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.

1719

{ # 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

1720

"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.

1721

"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.

1722

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1723

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1724

{ # Specification determining how headers are added to requests or responses.

1725

"headerName": "A String", # The name of the header.

1726

"headerValue": "A String", # The value of the header to add.

1727

"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.

1728

# The default value is false.

1729

},

1730

],

1731

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1732

"A String",

1733

],

1734

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1735

{ # Specification determining how headers are added to requests or responses.

1736

"headerName": "A String", # The name of the header.

1737

"headerValue": "A String", # The value of the header to add.

1738

"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.

1739

# The default value is false.

1740

},

1741

],

1742

"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) .

1747

# 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.

1748

# 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.

1753

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1754

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1755

# If urlRedirect is specified, service or routeAction must not be set.

1756

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1757

# The value must be between 1 and 255 characters.

1758

"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.

1759

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1760

# The default is set to false.

1761

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1762

# 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.

1763

# The value must be between 1 and 1024 characters.

1764

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1765

# 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.

1766

# The value must be between 1 and 1024 characters.

1767

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1768

# Supported values are:

1769

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1770

# - FOUND, which corresponds to 302.

1771

# - SEE_OTHER which corresponds to 303.

1772

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1773

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1774

"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.

1775

# 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.

1782

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1783

"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.

1784

{ # Message for the expected URL mappings.

1785

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

1786

"description": "A String", # Description of this test case.

1787

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

1788

"host": "A String", # Host portion of the URL.

1789

"path": "A String", # Path portion of the URL.

1790

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1791

},

1792

],

1793

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1794

1795

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

1796

1797

Returns:

1798

An object of the form:

1799

1800

{ # Represents an Operation resource.

1801

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1802

# Google Compute Engine has three Operation resources:

1803

#

1804

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1805

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1806

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1807

#

1808

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1809

# - For global operations, use the `globalOperations` resource.

1810

# - For regional operations, use the `regionOperations` resource.

1811

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1812

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1813

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1814

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1815

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1816

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1817

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1818

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1819

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1820

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1821

"code": "A String", # [Output Only] The error type identifier for this error.

1822

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1823

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1824

},

1825

],

1826

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1827

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1828

"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.

1829

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1830

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1831

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1832

"name": "A String", # [Output Only] Name of the operation.

1833

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1834

"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.

1835

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1836

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1837

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1838

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1839

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1840

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1841

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1842

"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.

1843

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1844

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1845

{

1846

"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.

1847

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1848

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1849

{

1850

"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).

1851

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1852

},

1853

],

1854

"message": "A String", # [Output Only] A human-readable description of the warning code.

1855

},

1856

],

1857

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1862

<code class="details" id="invalidateCache">invalidateCache(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1863

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

1864

1865

Args:

1866

project: string, Project ID for this request. (required)

1867

region: string, Name of the region scoping this request. (required)

1868

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1869

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1870

The object takes the form of:

1871

1872

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1873

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

1874

"path": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1875

}

1876

1877

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

1878

1879

Returns:

1880

An object of the form:

1881

1882

{ # Represents an Operation resource.

1883

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1884

# Google Compute Engine has three Operation resources:

1885

#

1886

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

1887

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1888

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

1889

#

1890

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1891

# - For global operations, use the `globalOperations` resource.

1892

# - For regional operations, use the `regionOperations` resource.

1893

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1894

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1895

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1896

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1897

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1898

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1899

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1900

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1901

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1902

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1903

"code": "A String", # [Output Only] The error type identifier for this error.

1904

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1905

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1906

},

1907

],

1908

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1910

"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.

1911

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1912

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1913

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1914

"name": "A String", # [Output Only] Name of the operation.

1915

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1916

"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.

1917

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1918

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1919

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

1920

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1921

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1922

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1923

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1924

"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.

1925

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1926

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1927

{

1928

"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.

1929

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

1930

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

1931

{

1932

"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).

1933

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1934

},

1935

],

1936

"message": "A String", # [Output Only] A human-readable description of the warning code.

1937

},

1938

],

1939

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1944

<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1945

<pre>Retrieves the list of UrlMap resources available to the specified project in the specified region.

1946

1947

Args:

1948

project: string, Project ID for this request. (required)

1949

region: string, Name of the region scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1950

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1951

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1952

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1953

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1954

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1955

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1956

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) ```

1957

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`)

1958

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

1959

1960

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.

1961

1962

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

1963

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.

1964

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1965

1966

Returns:

1967

An object of the form:

1968

1969

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1970

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

1971

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1972

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1973

#

1974

# Google Compute Engine has two URL Map resources:

1975

#

1976

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1977

#

1978

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1979

#

1980

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1981

#

1982

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1983

#

1984

# 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.

1985

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1986

"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.

1987

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1988

"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

1989

"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.

1990

# Default is false.

1991

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1992

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1993

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1994

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1995

"A String",

1996

],

1997

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1998

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1999

"A String",

2000

],

2001

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2002

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2003

"A String",

2004

],

2005

"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.

2006

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2007

"A String",

2008

],

2009

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2010

},

2011

"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.

2012

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2013

"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.

2014

"httpStatus": 42, # The HTTP status code used to abort the request.

2015

# The value must be between 200 and 599 inclusive.

2016

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2017

# The value must be between 0.0 and 100.0 inclusive.

2018

},

2019

"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.

2020

"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.

2021

"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.

2022

"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

2023

},

2024

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2025

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2026

},

2027

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2028

"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.

2029

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2030

},

2031

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2032

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2033

"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.

2034

# 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.

2035

"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.

2036

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2037

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2038

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2039

# - 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.

2040

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2041

# -

2042

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2043

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2044

# - 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.

2045

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2046

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2047

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2048

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2049

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2050

],

2051

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

"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.

2053

# If not specified, will use the largest timeout among all backend services associated with the route.

2054

"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.

2055

"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

2056

},

2057

"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.

2058

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2059

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2060

"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.

2061

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2062

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2063

"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.

2064

# 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.

2065

{ # 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

2066

"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.

2067

"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.

2068

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2069

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2070

{ # Specification determining how headers are added to requests or responses.

2071

"headerName": "A String", # The name of the header.

2072

"headerValue": "A String", # The value of the header to add.

2073

"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.

2074

# The default value is false.

2075

},

2076

],

2077

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2078

"A String",

2079

],

2080

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2081

{ # Specification determining how headers are added to requests or responses.

2082

"headerName": "A String", # The name of the header.

2083

"headerValue": "A String", # The value of the header to add.

2084

"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.

2085

# The default value is false.

2086

},

2087

],

2088

"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) .

2093

# 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.

2094

# The value must be between 0 and 1000

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2095

},

2096

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2097

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2098

"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.

2099

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2100

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2101

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2102

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2103

# The value must be between 1 and 255 characters.

2104

"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.

2105

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2106

# The default is set to false.

2107

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2108

# 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.

2109

# The value must be between 1 and 1024 characters.

2110

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2111

# 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.

2112

# The value must be between 1 and 1024 characters.

2113

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2114

# Supported values are:

2115

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2116

# - FOUND, which corresponds to 302.

2117

# - SEE_OTHER which corresponds to 303.

2118

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2119

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2120

"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.

2121

# The default is set to false.

2122

},

2123

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2124

"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.

2125

#

2126

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2127

"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.

2128

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2129

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2130

{ # Specification determining how headers are added to requests or responses.

2131

"headerName": "A String", # The name of the header.

2132

"headerValue": "A String", # The value of the header to add.

2133

"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.

2134

# The default value is false.

2135

},

2136

],

2137

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2138

"A String",

2139

],

2140

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2141

{ # Specification determining how headers are added to requests or responses.

2142

"headerName": "A String", # The name of the header.

2143

"headerValue": "A String", # The value of the header to add.

2144

"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.

2145

# The default value is false.

2146

},

2147

],

2148

"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.

2153

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2154

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2155

"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 ..

2156

"A String",

2157

],

2158

"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.

2159

},

2160

],

2161

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2162

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2163

"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.

2164

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2165

{ # 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.

2166

"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.

2167

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2168

"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

2169

"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.

2170

# Default is false.

2171

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2172

"A String",

2173

],

2174

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2175

"A String",

2176

],

2177

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2178

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2179

"A String",

2180

],

2181

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2182

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2183

"A String",

2184

],

2185

"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.

2186

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2187

"A String",

2188

],

2189

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2190

},

2191

"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.

2192

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2193

"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.

2194

"httpStatus": 42, # The HTTP status code used to abort the request.

2195

# The value must be between 200 and 599 inclusive.

2196

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2197

# The value must be between 0.0 and 100.0 inclusive.

2198

},

2199

"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.

2200

"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.

2201

"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.

2202

"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

2203

},

2204

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2205

# The value must be between 0.0 and 100.0 inclusive.

2206

},

2207

},

2208

"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.

2209

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2210

},

2211

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2212

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2213

"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.

2214

# 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.

2215

"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.

2216

"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

2217

},

2218

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2219

# - 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.

2220

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2221

# -

2222

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2223

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2224

# - 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.

2225

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2226

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2227

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2228

# - 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.

2233

# If not specified, will use the largest timeout among all backend services associated with the route.

2234

"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.

2235

"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

2236

},

2237

"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.

2238

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2239

# The value must be between 1 and 255 characters.

2240

"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.

2241

# The value must be between 1 and 1024 characters.

2242

},

2243

"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.

2244

# 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.

2245

{ # 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

2246

"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.

2247

"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.

2248

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2249

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2250

{ # Specification determining how headers are added to requests or responses.

2251

"headerName": "A String", # The name of the header.

2252

"headerValue": "A String", # The value of the header to add.

2253

"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.

2254

# The default value is false.

2255

},

2256

],

2257

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2258

"A String",

2259

],

2260

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2261

{ # Specification determining how headers are added to requests or responses.

2262

"headerName": "A String", # The name of the header.

2263

"headerValue": "A String", # The value of the header to add.

2264

"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.

2265

# The default value is false.

2266

},

2267

],

2268

"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) .

2273

# 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.

2274

# 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:

2279

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2280

# - compute/v1/projects/project/global/backendServices/backendService

2281

# - 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.

2282

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2283

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2284

# - compute.backendBuckets.use

2285

# - compute.backendServices.use

2286

"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.

2287

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2288

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2289

# The value must be between 1 and 255 characters.

2290

"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.

2291

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2292

# The default is set to false.

2293

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2294

# 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.

2295

# The value must be between 1 and 1024 characters.

2296

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2297

# 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.

2298

# The value must be between 1 and 1024 characters.

2299

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2300

# Supported values are:

2301

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2302

# - FOUND, which corresponds to 302.

2303

# - SEE_OTHER which corresponds to 303.

2304

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2305

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2306

"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.

2307

# The default is set to false.

2308

},

2309

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2310

"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.

2311

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2312

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

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

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2321

"A String",

2322

],

2323

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2324

{ # Specification determining how headers are added to requests or responses.

2325

"headerName": "A String", # The name of the header.

2326

"headerValue": "A String", # The value of the header to add.

2327

"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.

2328

# The default value is false.

2329

},

2330

],

2331

"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.

2336

"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.

2337

# 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.

2338

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2339

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2340

"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.

2341

"A String",

2342

],

2343

"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.

2344

# Only one of routeAction or urlRedirect must be set.

2345

"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

2346

"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.

2347

# Default is false.

2348

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2349

"A String",

2350

],

2351

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2352

"A String",

2353

],

2354

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2355

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2356

"A String",

2357

],

2358

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2359

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2360

"A String",

2361

],

2362

"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.

2363

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2364

"A String",

2365

],

2366

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2367

},

2368

"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.

2369

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2370

"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.

2371

"httpStatus": 42, # The HTTP status code used to abort the request.

2372

# The value must be between 200 and 599 inclusive.

2373

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2374

# The value must be between 0.0 and 100.0 inclusive.

2375

},

2376

"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.

2377

"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.

2378

"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.

2379

"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

2380

},

2381

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2382

# The value must be between 0.0 and 100.0 inclusive.

2383

},

2384

},

2385

"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.

2386

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2387

},

2388

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2389

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2390

"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.

2391

# 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.

2392

"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.

2393

"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

2394

},

2395

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2396

# - 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.

2397

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2398

# -

2399

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2400

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2401

# - 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.

2402

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2403

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2404

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2405

# - 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.

2410

# If not specified, will use the largest timeout among all backend services associated with the route.

2411

"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.

2412

"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

2413

},

2414

"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.

2415

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2416

# The value must be between 1 and 255 characters.

2417

"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.

2418

# The value must be between 1 and 1024 characters.

2419

},

2420

"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.

2421

# 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.

2422

{ # 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

2423

"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.

2424

"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.

2425

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2426

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2427

{ # Specification determining how headers are added to requests or responses.

2428

"headerName": "A String", # The name of the header.

2429

"headerValue": "A String", # The value of the header to add.

2430

"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.

2431

# The default value is false.

2432

},

2433

],

2434

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2435

"A String",

2436

],

2437

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2438

{ # Specification determining how headers are added to requests or responses.

2439

"headerName": "A String", # The name of the header.

2440

"headerValue": "A String", # The value of the header to add.

2441

"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.

2442

# The default value is false.

2443

},

2444

],

2445

"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) .

2450

# 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.

2451

# 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.

2456

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2457

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2458

# If urlRedirect is specified, service or routeAction must not be set.

2459

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2460

# The value must be between 1 and 255 characters.

2461

"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.

2462

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2463

# The default is set to false.

2464

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2465

# 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.

2466

# The value must be between 1 and 1024 characters.

2467

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2468

# 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.

2469

# The value must be between 1 and 1024 characters.

2470

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2471

# Supported values are:

2472

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2473

# - FOUND, which corresponds to 302.

2474

# - SEE_OTHER which corresponds to 303.

2475

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2476

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2477

"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.

2478

# 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.

2483

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2484

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2485

"description": "A String", # The short description conveying the intent of this routeRule.

2486

# The description can have a maximum length of 1024 characters.

2487

"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.

2488

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2489

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2490

{ # Specification determining how headers are added to requests or responses.

2491

"headerName": "A String", # The name of the header.

2492

"headerValue": "A String", # The value of the header to add.

2493

"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.

2494

# The default value is false.

2495

},

2496

],

2497

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2498

"A String",

2499

],

2500

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2501

{ # Specification determining how headers are added to requests or responses.

2502

"headerName": "A String", # The name of the header.

2503

"headerValue": "A String", # The value of the header to add.

2504

"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.

2505

# The default value is false.

2506

},

2507

],

2508

"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",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2513

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2514

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2515

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2516

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

2517

},

2518

],

2519

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2520

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

2521

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2522

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2523

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2524

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2529

"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.

2530

# fullPathMatch must be between 1 and 1024 characters.

2531

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2532

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2533

{ # matchRule criteria for request header matches.

2534

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2535

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2536

"headerName": "A String", # The name of the HTTP header to match.

2537

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2538

# For matching a request's method, use the headerName ":method".

2539

"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.

2540

# The default setting is false.

2541

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2542

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2543

"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.

2544

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2545

"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.

2546

# For example for a range [-5, 0]

2547

# - -3 will match.

2548

# - 0 will not match.

2549

# - 0.25 will not match.

2550

# - -3someString will not match.

2551

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2552

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2553

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2554

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2555

},

2556

"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

2557

# 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.

2558

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2559

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2560

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2561

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2562

},

2563

],

2564

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2565

# The default value is false.

2566

# ignoreCase must not be used with regexMatch.

2567

"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.

2568

# 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.

2569

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2570

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2571

{ # 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.

2572

# 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.

2573

# 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.

2574

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2575

# This list must not be empty and can have at the most 64 entries.

2576

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2577

"name": "A String", # Name of metadata label.

2578

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2579

"value": "A String", # The value of the label must match the specified value.

2580

# value can have a maximum length of 1024 characters.

2581

},

2582

],

2583

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2584

# Supported values are:

2585

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2586

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2587

},

2588

],

2589

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2590

# The value must be between 1 and 1024 characters.

2591

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2592

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2593

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2594

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2595

# Only one of presentMatch, exactMatch or regexMatch must be set.

2596

"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.

2597

"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.

2598

# Only one of presentMatch, exactMatch or regexMatch must be set.

2599

"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

2600

# Only one of presentMatch, exactMatch or regexMatch must be set.

2601

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2602

},

2603

],

2604

"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

2605

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2606

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2607

},

2608

],

2609

"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.

2610

# 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.

2611

# 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.

2612

"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.

2613

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2614

"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

2615

"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.

2616

# Default is false.

2617

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2618

"A String",

2619

],

2620

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2621

"A String",

2622

],

2623

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2624

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2625

"A String",

2626

],

2627

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2628

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2629

"A String",

2630

],

2631

"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.

2632

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2633

"A String",

2634

],

2635

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2636

},

2637

"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.

2638

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2639

"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.

2640

"httpStatus": 42, # The HTTP status code used to abort the request.

2641

# The value must be between 200 and 599 inclusive.

2642

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2643

# The value must be between 0.0 and 100.0 inclusive.

2644

},

2645

"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.

2646

"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.

2647

"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.

2648

"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

2649

},

2650

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2651

# The value must be between 0.0 and 100.0 inclusive.

2652

},

2653

},

2654

"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.

2655

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2656

},

2657

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2658

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2659

"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.

2660

# 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.

2661

"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.

2662

"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

2663

},

2664

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2665

# - 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.

2666

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2667

# -

2668

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2669

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2670

# - 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.

2671

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2672

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2673

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2674

# - 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.

2679

# If not specified, will use the largest timeout among all backend services associated with the route.

2680

"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.

2681

"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

2682

},

2683

"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.

2684

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2685

# The value must be between 1 and 255 characters.

2686

"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.

2687

# The value must be between 1 and 1024 characters.

2688

},

2689

"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.

2690

# 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.

2691

{ # 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

2692

"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.

2693

"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.

2694

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2695

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2696

{ # Specification determining how headers are added to requests or responses.

2697

"headerName": "A String", # The name of the header.

2698

"headerValue": "A String", # The value of the header to add.

2699

"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.

2700

# The default value is false.

2701

},

2702

],

2703

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2704

"A String",

2705

],

2706

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2707

{ # Specification determining how headers are added to requests or responses.

2708

"headerName": "A String", # The name of the header.

2709

"headerValue": "A String", # The value of the header to add.

2710

"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.

2711

# The default value is false.

2712

},

2713

],

2714

"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) .

2719

# 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.

2720

# 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.

2725

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2726

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2727

# If urlRedirect is specified, service or routeAction must not be set.

2728

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2729

# The value must be between 1 and 255 characters.

2730

"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.

2731

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2732

# The default is set to false.

2733

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2734

# 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.

2735

# The value must be between 1 and 1024 characters.

2736

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2737

# 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.

2738

# The value must be between 1 and 1024 characters.

2739

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2740

# Supported values are:

2741

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2742

# - FOUND, which corresponds to 302.

2743

# - SEE_OTHER which corresponds to 303.

2744

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2745

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2746

"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.

2747

# 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.

2754

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2755

"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.

2756

{ # Message for the expected URL mappings.

2757

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

2758

"description": "A String", # Description of this test case.

2759

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

2760

"host": "A String", # Host portion of the URL.

2761

"path": "A String", # Path portion of the URL.

2762

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2763

},

2764

],

2765

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2766

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2767

"kind": "compute#urlMapList", # Type of resource.

2768

"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.

2769

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2770

"warning": { # [Output Only] Informational warning message.

2771

"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.

2772

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2773

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2774

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2775

"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).

2776

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2777

},

2778

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2779

"message": "A String", # [Output Only] A human-readable description of the warning code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2780

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2786

<pre>Retrieves the next page of results.

2787

2788

Args:

2789

previous_request: The request for the previous page. (required)

2790

previous_response: The response from the request for the previous page. (required)

2791

2792

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2793

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2794

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2799

<code class="details" id="patch">patch(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2800

<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.

2801

2802

Args:

2803

project: string, Project ID for this request. (required)

2804

region: string, Name of the region scoping this request. (required)

2805

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2806

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2807

The object takes the form of:

2808

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2809

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2810

#

2811

# Google Compute Engine has two URL Map resources:

2812

#

2813

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2814

#

2815

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2816

#

2817

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2818

#

2819

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2820

#

2821

# 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.

2822

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2823

"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.

2824

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2825

"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

2826

"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.

2827

# Default is false.

2828

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2829

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2830

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2831

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2832

"A String",

2833

],

2834

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2835

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2836

"A String",

2837

],

2838

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2839

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2840

"A String",

2841

],

2842

"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.

2843

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2844

"A String",

2845

],

2846

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2847

},

2848

"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.

2849

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2850

"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.

2851

"httpStatus": 42, # The HTTP status code used to abort the request.

2852

# The value must be between 200 and 599 inclusive.

2853

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2854

# The value must be between 0.0 and 100.0 inclusive.

2855

},

2856

"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.

2857

"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.

2858

"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.

2859

"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

2860

},

2861

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2862

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2863

},

2864

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2865

"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.

2866

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2867

},

2868

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2869

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2870

"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.

2871

# 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.

2872

"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.

2873

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2874

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2876

# - 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.

2877

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2878

# -

2879

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2880

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2881

# - 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.

2882

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2883

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2884

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2885

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2886

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2887

],

2888

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2889

"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.

2890

# If not specified, will use the largest timeout among all backend services associated with the route.

2891

"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.

2892

"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

2893

},

2894

"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.

2895

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2896

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2897

"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.

2898

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2899

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2900

"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.

2901

# 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.

2902

{ # 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

2903

"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.

2904

"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.

2905

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2906

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2907

{ # Specification determining how headers are added to requests or responses.

2908

"headerName": "A String", # The name of the header.

2909

"headerValue": "A String", # The value of the header to add.

2910

"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.

2911

# The default value is false.

2912

},

2913

],

2914

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2915

"A String",

2916

],

2917

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2918

{ # Specification determining how headers are added to requests or responses.

2919

"headerName": "A String", # The name of the header.

2920

"headerValue": "A String", # The value of the header to add.

2921

"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.

2922

# The default value is false.

2923

},

2924

],

2925

"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) .

2930

# 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.

2931

# The value must be between 0 and 1000

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2932

},

2933

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2934

},

2935

"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.

2936

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2937

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2938

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2939

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2940

# The value must be between 1 and 255 characters.

2941

"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.

2942

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2943

# The default is set to false.

2944

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2945

# 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.

2946

# The value must be between 1 and 1024 characters.

2947

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2948

# 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.

2949

# The value must be between 1 and 1024 characters.

2950

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2951

# Supported values are:

2952

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2953

# - FOUND, which corresponds to 302.

2954

# - SEE_OTHER which corresponds to 303.

2955

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2956

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2957

"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.

2958

# The default is set to false.

2959

},

2960

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2961

"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.

2962

#

2963

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2964

"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.

2965

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2966

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2967

{ # Specification determining how headers are added to requests or responses.

2968

"headerName": "A String", # The name of the header.

2969

"headerValue": "A String", # The value of the header to add.

2970

"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.

2971

# The default value is false.

2972

},

2973

],

2974

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2975

"A String",

2976

],

2977

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2978

{ # Specification determining how headers are added to requests or responses.

2979

"headerName": "A String", # The name of the header.

2980

"headerValue": "A String", # The value of the header to add.

2981

"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.

2982

# The default value is false.

2983

},

2984

],

2985

"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.

2990

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2991

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2992

"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 ..

2993

"A String",

2994

],

2995

"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.

2996

},

2997

],

2998

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2999

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3000

"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.

3001

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3002

{ # 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.

3003

"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.

3004

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3005

"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

3006

"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.

3007

# Default is false.

3008

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3009

"A String",

3010

],

3011

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3012

"A String",

3013

],

3014

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3015

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3016

"A String",

3017

],

3018

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3019

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3020

"A String",

3021

],

3022

"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.

3023

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3024

"A String",

3025

],

3026

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3027

},

3028

"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.

3029

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3030

"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.

3031

"httpStatus": 42, # The HTTP status code used to abort the request.

3032

# The value must be between 200 and 599 inclusive.

3033

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3034

# The value must be between 0.0 and 100.0 inclusive.

3035

},

3036

"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.

3037

"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.

3038

"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.

3039

"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

3040

},

3041

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3042

# The value must be between 0.0 and 100.0 inclusive.

3043

},

3044

},

3045

"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.

3046

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3047

},

3048

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3049

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3050

"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.

3051

# 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.

3052

"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.

3053

"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

3054

},

3055

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3056

# - 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.

3057

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3058

# -

3059

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3060

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3061

# - 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.

3062

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3063

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3064

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3065

# - 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.

3070

# If not specified, will use the largest timeout among all backend services associated with the route.

3071

"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.

3072

"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

3073

},

3074

"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.

3075

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3076

# The value must be between 1 and 255 characters.

3077

"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.

3078

# The value must be between 1 and 1024 characters.

3079

},

3080

"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.

3081

# 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.

3082

{ # 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

3083

"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.

3084

"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.

3085

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3086

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3087

{ # Specification determining how headers are added to requests or responses.

3088

"headerName": "A String", # The name of the header.

3089

"headerValue": "A String", # The value of the header to add.

3090

"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.

3091

# The default value is false.

3092

},

3093

],

3094

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3095

"A String",

3096

],

3097

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3098

{ # Specification determining how headers are added to requests or responses.

3099

"headerName": "A String", # The name of the header.

3100

"headerValue": "A String", # The value of the header to add.

3101

"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.

3102

# The default value is false.

3103

},

3104

],

3105

"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) .

3110

# 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.

3111

# 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:

3116

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3117

# - compute/v1/projects/project/global/backendServices/backendService

3118

# - 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.

3119

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3120

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3121

# - compute.backendBuckets.use

3122

# - compute.backendServices.use

3123

"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.

3124

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3125

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3126

# The value must be between 1 and 255 characters.

3127

"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.

3128

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3129

# The default is set to false.

3130

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3131

# 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.

3132

# The value must be between 1 and 1024 characters.

3133

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3134

# 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.

3135

# The value must be between 1 and 1024 characters.

3136

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3137

# Supported values are:

3138

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3139

# - FOUND, which corresponds to 302.

3140

# - SEE_OTHER which corresponds to 303.

3141

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3142

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3143

"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.

3144

# The default is set to false.

3145

},

3146

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3147

"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.

3148

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3149

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3150

{ # Specification determining how headers are added to requests or responses.

3151

"headerName": "A String", # The name of the header.

3152

"headerValue": "A String", # The value of the header to add.

3153

"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.

3154

# The default value is false.

3155

},

3156

],

3157

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3158

"A String",

3159

],

3160

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3161

{ # Specification determining how headers are added to requests or responses.

3162

"headerName": "A String", # The name of the header.

3163

"headerValue": "A String", # The value of the header to add.

3164

"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.

3165

# The default value is false.

3166

},

3167

],

3168

"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.

3173

"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.

3174

# 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.

3175

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3176

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3177

"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.

3178

"A String",

3179

],

3180

"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.

3181

# Only one of routeAction or urlRedirect must be set.

3182

"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

3183

"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.

3184

# Default is false.

3185

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3186

"A String",

3187

],

3188

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3189

"A String",

3190

],

3191

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3192

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3193

"A String",

3194

],

3195

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3196

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3197

"A String",

3198

],

3199

"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.

3200

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3201

"A String",

3202

],

3203

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3204

},

3205

"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.

3206

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3207

"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.

3208

"httpStatus": 42, # The HTTP status code used to abort the request.

3209

# The value must be between 200 and 599 inclusive.

3210

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3211

# The value must be between 0.0 and 100.0 inclusive.

3212

},

3213

"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.

3214

"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.

3215

"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.

3216

"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

3217

},

3218

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3219

# The value must be between 0.0 and 100.0 inclusive.

3220

},

3221

},

3222

"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.

3223

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3224

},

3225

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3226

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3227

"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.

3228

# 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.

3229

"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.

3230

"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

3231

},

3232

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3233

# - 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.

3234

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3235

# -

3236

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3237

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3238

# - 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.

3239

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3240

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3241

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3242

# - 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.

3247

# If not specified, will use the largest timeout among all backend services associated with the route.

3248

"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.

3249

"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

3250

},

3251

"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.

3252

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3253

# The value must be between 1 and 255 characters.

3254

"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.

3255

# The value must be between 1 and 1024 characters.

3256

},

3257

"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.

3258

# 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.

3259

{ # 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

3260

"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.

3261

"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.

3262

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3263

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3264

{ # Specification determining how headers are added to requests or responses.

3265

"headerName": "A String", # The name of the header.

3266

"headerValue": "A String", # The value of the header to add.

3267

"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.

3268

# The default value is false.

3269

},

3270

],

3271

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3272

"A String",

3273

],

3274

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3275

{ # Specification determining how headers are added to requests or responses.

3276

"headerName": "A String", # The name of the header.

3277

"headerValue": "A String", # The value of the header to add.

3278

"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.

3279

# The default value is false.

3280

},

3281

],

3282

"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) .

3287

# 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.

3288

# 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.

3293

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3294

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3295

# If urlRedirect is specified, service or routeAction must not be set.

3296

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3297

# The value must be between 1 and 255 characters.

3298

"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.

3299

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3300

# The default is set to false.

3301

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3302

# 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.

3303

# The value must be between 1 and 1024 characters.

3304

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3305

# 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.

3306

# The value must be between 1 and 1024 characters.

3307

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3308

# Supported values are:

3309

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3310

# - FOUND, which corresponds to 302.

3311

# - SEE_OTHER which corresponds to 303.

3312

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3313

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3314

"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.

3315

# 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.

3320

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3321

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3322

"description": "A String", # The short description conveying the intent of this routeRule.

3323

# The description can have a maximum length of 1024 characters.

3324

"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.

3325

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3326

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3327

{ # Specification determining how headers are added to requests or responses.

3328

"headerName": "A String", # The name of the header.

3329

"headerValue": "A String", # The value of the header to add.

3330

"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.

3331

# The default value is false.

3332

},

3333

],

3334

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3335

"A String",

3336

],

3337

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3338

{ # Specification determining how headers are added to requests or responses.

3339

"headerName": "A String", # The name of the header.

3340

"headerValue": "A String", # The value of the header to add.

3341

"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.

3342

# The default value is false.

3343

},

3344

],

3345

"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",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3350

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3351

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3352

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3353

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

3354

},

3355

],

3356

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3357

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

3358

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3359

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3360

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3361

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3366

"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.

3367

# fullPathMatch must be between 1 and 1024 characters.

3368

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3369

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3370

{ # matchRule criteria for request header matches.

3371

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3372

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3373

"headerName": "A String", # The name of the HTTP header to match.

3374

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3375

# For matching a request's method, use the headerName ":method".

3376

"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.

3377

# The default setting is false.

3378

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3379

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3380

"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.

3381

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3382

"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.

3383

# For example for a range [-5, 0]

3384

# - -3 will match.

3385

# - 0 will not match.

3386

# - 0.25 will not match.

3387

# - -3someString will not match.

3388

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3389

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3390

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3391

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3392

},

3393

"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

3394

# 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.

3395

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3396

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3397

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3398

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3399

},

3400

],

3401

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3402

# The default value is false.

3403

# ignoreCase must not be used with regexMatch.

3404

"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.

3405

# 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.

3406

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3407

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3408

{ # 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.

3409

# 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.

3410

# 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.

3411

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3412

# This list must not be empty and can have at the most 64 entries.

3413

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3414

"name": "A String", # Name of metadata label.

3415

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3416

"value": "A String", # The value of the label must match the specified value.

3417

# value can have a maximum length of 1024 characters.

3418

},

3419

],

3420

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3421

# Supported values are:

3422

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3423

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3424

},

3425

],

3426

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3427

# The value must be between 1 and 1024 characters.

3428

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3429

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3430

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3431

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3432

# Only one of presentMatch, exactMatch or regexMatch must be set.

3433

"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.

3434

"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.

3435

# Only one of presentMatch, exactMatch or regexMatch must be set.

3436

"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

3437

# Only one of presentMatch, exactMatch or regexMatch must be set.

3438

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3439

},

3440

],

3441

"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

3442

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3443

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3444

},

3445

],

3446

"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.

3447

# 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.

3448

# 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.

3449

"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.

3450

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3451

"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

3452

"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.

3453

# Default is false.

3454

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3455

"A String",

3456

],

3457

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3458

"A String",

3459

],

3460

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3461

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3462

"A String",

3463

],

3464

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3465

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3466

"A String",

3467

],

3468

"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.

3469

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3470

"A String",

3471

],

3472

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3473

},

3474

"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.

3475

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3476

"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.

3477

"httpStatus": 42, # The HTTP status code used to abort the request.

3478

# The value must be between 200 and 599 inclusive.

3479

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3480

# The value must be between 0.0 and 100.0 inclusive.

3481

},

3482

"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.

3483

"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.

3484

"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.

3485

"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

3486

},

3487

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3488

# The value must be between 0.0 and 100.0 inclusive.

3489

},

3490

},

3491

"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.

3492

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3493

},

3494

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3495

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3496

"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.

3497

# 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.

3498

"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.

3499

"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

3500

},

3501

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3502

# - 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.

3503

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3504

# -

3505

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3506

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3507

# - 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.

3508

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3509

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3510

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3511

# - 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.

3516

# If not specified, will use the largest timeout among all backend services associated with the route.

3517

"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.

3518

"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

3519

},

3520

"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.

3521

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3522

# The value must be between 1 and 255 characters.

3523

"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.

3524

# The value must be between 1 and 1024 characters.

3525

},

3526

"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.

3527

# 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.

3528

{ # 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

3529

"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.

3530

"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.

3531

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3532

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3533

{ # Specification determining how headers are added to requests or responses.

3534

"headerName": "A String", # The name of the header.

3535

"headerValue": "A String", # The value of the header to add.

3536

"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.

3537

# The default value is false.

3538

},

3539

],

3540

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3541

"A String",

3542

],

3543

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3544

{ # Specification determining how headers are added to requests or responses.

3545

"headerName": "A String", # The name of the header.

3546

"headerValue": "A String", # The value of the header to add.

3547

"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.

3548

# The default value is false.

3549

},

3550

],

3551

"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) .

3556

# 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.

3557

# 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.

3562

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3563

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3564

# If urlRedirect is specified, service or routeAction must not be set.

3565

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3566

# The value must be between 1 and 255 characters.

3567

"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.

3568

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3569

# The default is set to false.

3570

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3571

# 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.

3572

# The value must be between 1 and 1024 characters.

3573

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3574

# 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.

3575

# The value must be between 1 and 1024 characters.

3576

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3577

# Supported values are:

3578

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3579

# - FOUND, which corresponds to 302.

3580

# - SEE_OTHER which corresponds to 303.

3581

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3582

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3583

"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.

3584

# 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.

3591

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3592

"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.

3593

{ # Message for the expected URL mappings.

3594

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

3595

"description": "A String", # Description of this test case.

3596

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

3597

"host": "A String", # Host portion of the URL.

3598

"path": "A String", # Path portion of the URL.

3599

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3600

},

3601

],

3602

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3603

3604

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

3605

3606

Returns:

3607

An object of the form:

3608

3609

{ # Represents an Operation resource.

3610

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3611

# Google Compute Engine has three Operation resources:

3612

#

3613

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

3614

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3615

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

3616

#

3617

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3618

# - For global operations, use the `globalOperations` resource.

3619

# - For regional operations, use the `regionOperations` resource.

3620

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3621

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3622

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3623

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3624

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3625

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3626

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3627

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3628

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3629

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

"code": "A String", # [Output Only] The error type identifier for this error.

3631

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3632

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3633

},

3634

],

3635

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3636

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3637

"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.

3638

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3639

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3640

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3641

"name": "A String", # [Output Only] Name of the operation.

3642

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3643

"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.

3644

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3645

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3646

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

3647

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3648

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3649

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3650

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3651

"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.

3652

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3653

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3654

{

3655

"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.

3656

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3657

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3658

{

3659

"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).

3660

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3661

},

3662

],

3663

"message": "A String", # [Output Only] A human-readable description of the warning code.

3664

},

3665

],

3666

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3671

<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3672

<pre>Returns permissions that a caller has on the specified resource.

3673

3674

Args:

3675

project: string, Project ID for this request. (required)

3676

region: string, The name of the region for this request. (required)

3677

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3678

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3679

The object takes the form of:

3680

3681

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3682

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

3683

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

3690

3691

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3692

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

3693

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3699

<code class="details" id="update">update(project, region, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3700

<pre>Updates the specified UrlMap resource with the data included in the request.

3701

3702

Args:

3703

project: string, Project ID for this request. (required)

3704

region: string, Name of the region scoping this request. (required)

3705

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3706

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3707

The object takes the form of:

3708

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3709

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3710

#

3711

# Google Compute Engine has two URL Map resources:

3712

#

3713

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3714

#

3715

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3716

#

3717

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3718

#

3719

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3720

#

3721

# 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.

3722

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3723

"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.

3724

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3725

"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

3726

"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.

3727

# Default is false.

3728

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3729

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3730

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3732

"A String",

3733

],

3734

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3735

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3736

"A String",

3737

],

3738

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3739

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3740

"A String",

3741

],

3742

"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.

3743

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3744

"A String",

3745

],

3746

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3747

},

3748

"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.

3749

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3750

"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.

3751

"httpStatus": 42, # The HTTP status code used to abort the request.

3752

# The value must be between 200 and 599 inclusive.

3753

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3754

# The value must be between 0.0 and 100.0 inclusive.

3755

},

3756

"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.

3757

"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.

3758

"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.

3759

"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

3760

},

3761

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3762

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3763

},

3764

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3765

"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.

3766

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3767

},

3768

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3769

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3770

"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.

3771

# 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.

3772

"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.

3773

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3774

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3775

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3776

# - 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.

3777

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3778

# -

3779

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3780

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3781

# - 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.

3782

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3783

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3784

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3785

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3786

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3787

],

3788

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

"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.

3790

# If not specified, will use the largest timeout among all backend services associated with the route.

3791

"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.

3792

"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

3793

},

3794

"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.

3795

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3796

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3797

"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.

3798

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3799

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3800

"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.

3801

# 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.

3802

{ # 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

3803

"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.

3804

"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.

3805

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3806

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3807

{ # Specification determining how headers are added to requests or responses.

3808

"headerName": "A String", # The name of the header.

3809

"headerValue": "A String", # The value of the header to add.

3810

"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.

3811

# The default value is false.

3812

},

3813

],

3814

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3815

"A String",

3816

],

3817

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3818

{ # Specification determining how headers are added to requests or responses.

3819

"headerName": "A String", # The name of the header.

3820

"headerValue": "A String", # The value of the header to add.

3821

"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.

3822

# The default value is false.

3823

},

3824

],

3825

"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) .

3830

# 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.

3831

# The value must be between 0 and 1000

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3832

},

3833

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3834

},

3835

"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.

3836

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3837

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3838

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3839

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3840

# The value must be between 1 and 255 characters.

3841

"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.

3842

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3843

# The default is set to false.

3844

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3845

# 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.

3846

# The value must be between 1 and 1024 characters.

3847

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3848

# 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.

3849

# The value must be between 1 and 1024 characters.

3850

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3851

# Supported values are:

3852

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3853

# - FOUND, which corresponds to 302.

3854

# - SEE_OTHER which corresponds to 303.

3855

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3856

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3857

"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.

3858

# The default is set to false.

3859

},

3860

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3861

"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.

3862

#

3863

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3864

"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.

3865

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3866

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3867

{ # Specification determining how headers are added to requests or responses.

3868

"headerName": "A String", # The name of the header.

3869

"headerValue": "A String", # The value of the header to add.

3870

"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.

3871

# The default value is false.

3872

},

3873

],

3874

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3875

"A String",

3876

],

3877

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3878

{ # Specification determining how headers are added to requests or responses.

3879

"headerName": "A String", # The name of the header.

3880

"headerValue": "A String", # The value of the header to add.

3881

"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.

3882

# The default value is false.

3883

},

3884

],

3885

"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.

3890

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3891

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3892

"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 ..

3893

"A String",

3894

],

3895

"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.

3896

},

3897

],

3898

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3899

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3900

"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.

3901

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3902

{ # 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.

3903

"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.

3904

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3905

"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

3906

"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.

3907

# Default is false.

3908

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3909

"A String",

3910

],

3911

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3912

"A String",

3913

],

3914

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3915

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3916

"A String",

3917

],

3918

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3919

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3920

"A String",

3921

],

3922

"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.

3923

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3924

"A String",

3925

],

3926

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3927

},

3928

"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.

3929

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3930

"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.

3931

"httpStatus": 42, # The HTTP status code used to abort the request.

3932

# The value must be between 200 and 599 inclusive.

3933

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3934

# The value must be between 0.0 and 100.0 inclusive.

3935

},

3936

"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.

3937

"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.

3938

"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.

3939

"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

3940

},

3941

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3942

# The value must be between 0.0 and 100.0 inclusive.

3943

},

3944

},

3945

"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.

3946

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3947

},

3948

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3949

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3950

"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.

3951

# 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.

3952

"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.

3953

"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

3954

},

3955

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3956

# - 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.

3957

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3958

# -

3959

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3960

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3961

# - 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.

3962

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3963

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3964

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3965

# - 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.

3970

# If not specified, will use the largest timeout among all backend services associated with the route.

3971

"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.

3972

"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

3973

},

3974

"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.

3975

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3976

# The value must be between 1 and 255 characters.

3977

"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.

3978

# The value must be between 1 and 1024 characters.

3979

},

3980

"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.

3981

# 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.

3982

{ # 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

3983

"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.

3984

"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.

3985

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3986

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

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

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3995

"A String",

3996

],

3997

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3998

{ # Specification determining how headers are added to requests or responses.

3999

"headerName": "A String", # The name of the header.

4000

"headerValue": "A String", # The value of the header to add.

4001

"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.

4002

# The default value is false.

4003

},

4004

],

4005

"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) .

4010

# 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.

4011

# 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:

4016

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4017

# - compute/v1/projects/project/global/backendServices/backendService

4018

# - 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.

4019

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4020

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4021

# - compute.backendBuckets.use

4022

# - compute.backendServices.use

4023

"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.

4024

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4025

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4026

# The value must be between 1 and 255 characters.

4027

"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.

4028

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4029

# The default is set to false.

4030

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4031

# 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.

4032

# The value must be between 1 and 1024 characters.

4033

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4034

# 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.

4035

# The value must be between 1 and 1024 characters.

4036

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4037

# Supported values are:

4038

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4039

# - FOUND, which corresponds to 302.

4040

# - SEE_OTHER which corresponds to 303.

4041

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4042

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4043

"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.

4044

# The default is set to false.

4045

},

4046

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4047

"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.

4048

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4049

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

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

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4058

"A String",

4059

],

4060

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4061

{ # Specification determining how headers are added to requests or responses.

4062

"headerName": "A String", # The name of the header.

4063

"headerValue": "A String", # The value of the header to add.

4064

"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.

4065

# The default value is false.

4066

},

4067

],

4068

"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.

4073

"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.

4074

# 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.

4075

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4076

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4077

"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.

4078

"A String",

4079

],

4080

"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.

4081

# Only one of routeAction or urlRedirect must be set.

4082

"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

4083

"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.

4084

# Default is false.

4085

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4086

"A String",

4087

],

4088

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4089

"A String",

4090

],

4091

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4092

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4093

"A String",

4094

],

4095

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4096

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4097

"A String",

4098

],

4099

"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.

4100

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4101

"A String",

4102

],

4103

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4104

},

4105

"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.

4106

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4107

"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.

4108

"httpStatus": 42, # The HTTP status code used to abort the request.

4109

# The value must be between 200 and 599 inclusive.

4110

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4111

# The value must be between 0.0 and 100.0 inclusive.

4112

},

4113

"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.

4114

"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.

4115

"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.

4116

"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

4117

},

4118

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4119

# The value must be between 0.0 and 100.0 inclusive.

4120

},

4121

},

4122

"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.

4123

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4124

},

4125

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4126

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4127

"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.

4128

# 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.

4129

"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.

4130

"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

4131

},

4132

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4133

# - 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.

4134

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4135

# -

4136

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4137

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4138

# - 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.

4139

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4140

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4141

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4142

# - 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.

4147

# If not specified, will use the largest timeout among all backend services associated with the route.

4148

"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.

4149

"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

4150

},

4151

"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.

4152

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4153

# The value must be between 1 and 255 characters.

4154

"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.

4155

# The value must be between 1 and 1024 characters.

4156

},

4157

"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.

4158

# 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.

4159

{ # 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

4160

"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.

4161

"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.

4162

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4163

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4164

{ # Specification determining how headers are added to requests or responses.

4165

"headerName": "A String", # The name of the header.

4166

"headerValue": "A String", # The value of the header to add.

4167

"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.

4168

# The default value is false.

4169

},

4170

],

4171

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4172

"A String",

4173

],

4174

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4175

{ # Specification determining how headers are added to requests or responses.

4176

"headerName": "A String", # The name of the header.

4177

"headerValue": "A String", # The value of the header to add.

4178

"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.

4179

# The default value is false.

4180

},

4181

],

4182

"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) .

4187

# 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.

4188

# 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.

4193

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4194

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4195

# If urlRedirect is specified, service or routeAction must not be set.

4196

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4197

# The value must be between 1 and 255 characters.

4198

"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.

4199

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4200

# The default is set to false.

4201

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4202

# 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.

4203

# The value must be between 1 and 1024 characters.

4204

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4205

# 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.

4206

# The value must be between 1 and 1024 characters.

4207

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4208

# Supported values are:

4209

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4210

# - FOUND, which corresponds to 302.

4211

# - SEE_OTHER which corresponds to 303.

4212

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4213

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4214

"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.

4215

# 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.

4220

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4221

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4222

"description": "A String", # The short description conveying the intent of this routeRule.

4223

# The description can have a maximum length of 1024 characters.

4224

"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.

4225

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4226

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4227

{ # Specification determining how headers are added to requests or responses.

4228

"headerName": "A String", # The name of the header.

4229

"headerValue": "A String", # The value of the header to add.

4230

"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.

4231

# The default value is false.

4232

},

4233

],

4234

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4235

"A String",

4236

],

4237

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4238

{ # Specification determining how headers are added to requests or responses.

4239

"headerName": "A String", # The name of the header.

4240

"headerValue": "A String", # The value of the header to add.

4241

"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.

4242

# The default value is false.

4243

},

4244

],

4245

"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",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4250

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4251

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4252

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4253

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

4254

},

4255

],

4256

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4257

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

4258

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4259

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4260

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4261

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4266

"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.

4267

# fullPathMatch must be between 1 and 1024 characters.

4268

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4269

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4270

{ # matchRule criteria for request header matches.

4271

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4272

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4273

"headerName": "A String", # The name of the HTTP header to match.

4274

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4275

# For matching a request's method, use the headerName ":method".

4276

"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.

4277

# The default setting is false.

4278

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4279

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4280

"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.

4281

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4282

"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.

4283

# For example for a range [-5, 0]

4284

# - -3 will match.

4285

# - 0 will not match.

4286

# - 0.25 will not match.

4287

# - -3someString will not match.

4288

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4289

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4290

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4291

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4292

},

4293

"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

4294

# 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.

4295

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4296

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4297

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4298

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4299

},

4300

],

4301

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4302

# The default value is false.

4303

# ignoreCase must not be used with regexMatch.

4304

"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.

4305

# 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.

4306

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4307

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4308

{ # 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.

4309

# 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.

4310

# 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.

4311

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4312

# This list must not be empty and can have at the most 64 entries.

4313

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4314

"name": "A String", # Name of metadata label.

4315

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4316

"value": "A String", # The value of the label must match the specified value.

4317

# value can have a maximum length of 1024 characters.

4318

},

4319

],

4320

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4321

# Supported values are:

4322

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4323

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4324

},

4325

],

4326

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4327

# The value must be between 1 and 1024 characters.

4328

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4329

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4330

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4331

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4332

# Only one of presentMatch, exactMatch or regexMatch must be set.

4333

"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.

4334

"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.

4335

# Only one of presentMatch, exactMatch or regexMatch must be set.

4336

"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

4337

# Only one of presentMatch, exactMatch or regexMatch must be set.

4338

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4339

},

4340

],

4341

"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

4342

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4343

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4344

},

4345

],

4346

"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.

4347

# 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.

4348

# 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.

4349

"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.

4350

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4351

"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

4352

"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.

4353

# Default is false.

4354

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4355

"A String",

4356

],

4357

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4358

"A String",

4359

],

4360

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4361

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4362

"A String",

4363

],

4364

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4365

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4366

"A String",

4367

],

4368

"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.

4369

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4370

"A String",

4371

],

4372

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4373

},

4374

"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.

4375

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4376

"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.

4377

"httpStatus": 42, # The HTTP status code used to abort the request.

4378

# The value must be between 200 and 599 inclusive.

4379

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4380

# The value must be between 0.0 and 100.0 inclusive.

4381

},

4382

"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.

4383

"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.

4384

"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.

4385

"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

4386

},

4387

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4388

# The value must be between 0.0 and 100.0 inclusive.

4389

},

4390

},

4391

"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.

4392

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4393

},

4394

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4395

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4396

"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.

4397

# 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.

4398

"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.

4399

"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

4400

},

4401

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4402

# - 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.

4403

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4404

# -

4405

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4406

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4407

# - 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.

4408

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4409

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4410

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4411

# - 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.

4416

# If not specified, will use the largest timeout among all backend services associated with the route.

4417

"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.

4418

"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

4419

},

4420

"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.

4421

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4422

# The value must be between 1 and 255 characters.

4423

"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.

4424

# The value must be between 1 and 1024 characters.

4425

},

4426

"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.

4427

# 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.

4428

{ # 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

4429

"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.

4430

"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.

4431

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4432

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4433

{ # Specification determining how headers are added to requests or responses.

4434

"headerName": "A String", # The name of the header.

4435

"headerValue": "A String", # The value of the header to add.

4436

"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.

4437

# The default value is false.

4438

},

4439

],

4440

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4441

"A String",

4442

],

4443

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4444

{ # Specification determining how headers are added to requests or responses.

4445

"headerName": "A String", # The name of the header.

4446

"headerValue": "A String", # The value of the header to add.

4447

"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.

4448

# The default value is false.

4449

},

4450

],

4451

"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) .

4456

# 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.

4457

# 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.

4462

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4463

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4464

# If urlRedirect is specified, service or routeAction must not be set.

4465

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4466

# The value must be between 1 and 255 characters.

4467

"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.

4468

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4469

# The default is set to false.

4470

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4471

# 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.

4472

# The value must be between 1 and 1024 characters.

4473

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4474

# 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.

4475

# The value must be between 1 and 1024 characters.

4476

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4477

# Supported values are:

4478

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4479

# - FOUND, which corresponds to 302.

4480

# - SEE_OTHER which corresponds to 303.

4481

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4482

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4483

"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.

4484

# 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.

4491

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4492

"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.

4493

{ # Message for the expected URL mappings.

4494

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

4495

"description": "A String", # Description of this test case.

4496

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

4497

"host": "A String", # Host portion of the URL.

4498

"path": "A String", # Path portion of the URL.

4499

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4500

},

4501

],

4502

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4503

4504

requestId: string, begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.

4505

4506

Returns:

4507

An object of the form:

4508

4509

{ # Represents an Operation resource.

4510

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4511

# Google Compute Engine has three Operation resources:

4512

#

4513

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4514

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4515

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4516

#

4517

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4518

# - For global operations, use the `globalOperations` resource.

4519

# - For regional operations, use the `regionOperations` resource.

4520

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4521

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4522

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4523

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4524

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4525

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4526

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4527

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4528

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4529

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4530

"code": "A String", # [Output Only] The error type identifier for this error.

4531

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4532

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4533

},

4534

],

4535

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4536

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4537

"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.

4538

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4539

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4540

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4541

"name": "A String", # [Output Only] Name of the operation.

4542

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4543

"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.

4544

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4545

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4546

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4547

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4548

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4549

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4550

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4551

"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.

4552

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4553

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4554

{

4555

"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.

4556

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4557

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4558

{

4559

"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).

4560

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4561

},

4562

],

4563

"message": "A String", # [Output Only] A human-readable description of the warning code.

4564

},

4565

],

4566

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4571

<code class="details" id="validate">validate(project, region, urlMap, body=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4572

<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.

4573

4574

Args:

4575

project: string, Project ID for this request. (required)

4576

region: string, Name of the region scoping this request. (required)

4577

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4578

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4579

The object takes the form of:

4580

4581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4582

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

4583

#

4584

# Google Compute Engine has two URL Map resources:

4585

#

4586

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4587

#

4588

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4589

#

4590

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4591

#

4592

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4593

#

4594

# 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.

4595

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4596

"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.

4597

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4598

"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

4599

"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.

4600

# Default is false.

4601

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4602

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4603

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4604

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4605

"A String",

4606

],

4607

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4608

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4609

"A String",

4610

],

4611

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4612

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4613

"A String",

4614

],

4615

"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.

4616

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4617

"A String",

4618

],

4619

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4620

},

4621

"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.

4622

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4623

"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.

4624

"httpStatus": 42, # The HTTP status code used to abort the request.

4625

# The value must be between 200 and 599 inclusive.

4626

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4627

# The value must be between 0.0 and 100.0 inclusive.

4628

},

4629

"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.

4630

"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.

4631

"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.

4632

"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

4633

},

4634

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4635

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4636

},

4637

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4638

"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.

4639

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4640

},

4641

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4642

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4643

"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.

4644

# 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.

4645

"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.

4646

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4647

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4648

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4649

# - 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.

4650

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4651

# -

4652

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4653

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4654

# - 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.

4655

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4656

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4657

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4658

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4659

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4660

],

4661

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4662

"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.

4663

# If not specified, will use the largest timeout among all backend services associated with the route.

4664

"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.

4665

"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

4666

},

4667

"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.

4668

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4669

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4670

"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.

4671

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4672

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4673

"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.

4674

# 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.

4675

{ # 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

4676

"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.

4677

"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.

4678

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4679

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4680

{ # Specification determining how headers are added to requests or responses.

4681

"headerName": "A String", # The name of the header.

4682

"headerValue": "A String", # The value of the header to add.

4683

"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.

4684

# The default value is false.

4685

},

4686

],

4687

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4688

"A String",

4689

],

4690

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4691

{ # Specification determining how headers are added to requests or responses.

4692

"headerName": "A String", # The name of the header.

4693

"headerValue": "A String", # The value of the header to add.

4694

"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.

4695

# The default value is false.

4696

},

4697

],

4698

"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) .

4703

# 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.

4704

# The value must be between 0 and 1000

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4705

},

4706

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4707

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4708

"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.

4709

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4710

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4711

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4712

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4713

# The value must be between 1 and 255 characters.

4714

"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.

4715

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4716

# The default is set to false.

4717

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4718

# 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.

4719

# The value must be between 1 and 1024 characters.

4720

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4721

# 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.

4722

# The value must be between 1 and 1024 characters.

4723

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4724

# Supported values are:

4725

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4726

# - FOUND, which corresponds to 302.

4727

# - SEE_OTHER which corresponds to 303.

4728

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4729

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4730

"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.

4731

# The default is set to false.

4732

},

4733

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4734

"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.

4735

#

4736

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4737

"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.

4738

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4739

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4740

{ # Specification determining how headers are added to requests or responses.

4741

"headerName": "A String", # The name of the header.

4742

"headerValue": "A String", # The value of the header to add.

4743

"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.

4744

# The default value is false.

4745

},

4746

],

4747

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4748

"A String",

4749

],

4750

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4751

{ # Specification determining how headers are added to requests or responses.

4752

"headerName": "A String", # The name of the header.

4753

"headerValue": "A String", # The value of the header to add.

4754

"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.

4755

# The default value is false.

4756

},

4757

],

4758

"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.

4763

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4764

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4765

"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 ..

4766

"A String",

4767

],

4768

"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.

4769

},

4770

],

4771

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4772

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4773

"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.

4774

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4775

{ # 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.

4776

"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.

4777

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4778

"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

4779

"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.

4780

# Default is false.

4781

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4782

"A String",

4783

],

4784

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4785

"A String",

4786

],

4787

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4788

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4789

"A String",

4790

],

4791

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4792

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4793

"A String",

4794

],

4795

"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.

4796

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4797

"A String",

4798

],

4799

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4800

},

4801

"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.

4802

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4803

"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.

4804

"httpStatus": 42, # The HTTP status code used to abort the request.

4805

# The value must be between 200 and 599 inclusive.

4806

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4807

# The value must be between 0.0 and 100.0 inclusive.

4808

},

4809

"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.

4810

"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.

4811

"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.

4812

"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

4813

},

4814

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4815

# The value must be between 0.0 and 100.0 inclusive.

4816

},

4817

},

4818

"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.

4819

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4820

},

4821

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4822

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4823

"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.

4824

# 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.

4825

"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.

4826

"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

4827

},

4828

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4829

# - 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.

4830

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4831

# -

4832

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4833

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4834

# - 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.

4835

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4836

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4837

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4838

# - 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.

4843

# If not specified, will use the largest timeout among all backend services associated with the route.

4844

"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.

4845

"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

4846

},

4847

"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.

4848

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4849

# The value must be between 1 and 255 characters.

4850

"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.

4851

# The value must be between 1 and 1024 characters.

4852

},

4853

"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.

4854

# 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.

4855

{ # 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

4856

"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.

4857

"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.

4858

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4859

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4860

{ # Specification determining how headers are added to requests or responses.

4861

"headerName": "A String", # The name of the header.

4862

"headerValue": "A String", # The value of the header to add.

4863

"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.

4864

# The default value is false.

4865

},

4866

],

4867

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4868

"A String",

4869

],

4870

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4871

{ # Specification determining how headers are added to requests or responses.

4872

"headerName": "A String", # The name of the header.

4873

"headerValue": "A String", # The value of the header to add.

4874

"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.

4875

# The default value is false.

4876

},

4877

],

4878

"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) .

4883

# 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.

4884

# 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:

4889

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4890

# - compute/v1/projects/project/global/backendServices/backendService

4891

# - 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.

4892

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4893

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4894

# - compute.backendBuckets.use

4895

# - compute.backendServices.use

4896

"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.

4897

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4898

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4899

# The value must be between 1 and 255 characters.

4900

"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.

4901

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4902

# The default is set to false.

4903

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4904

# 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.

4905

# The value must be between 1 and 1024 characters.

4906

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4907

# 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.

4908

# The value must be between 1 and 1024 characters.

4909

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4910

# Supported values are:

4911

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4912

# - FOUND, which corresponds to 302.

4913

# - SEE_OTHER which corresponds to 303.

4914

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4915

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4916

"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.

4917

# The default is set to false.

4918

},

4919

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4920

"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.

4921

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4922

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4923

{ # Specification determining how headers are added to requests or responses.

4924

"headerName": "A String", # The name of the header.

4925

"headerValue": "A String", # The value of the header to add.

4926

"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.

4927

# The default value is false.

4928

},

4929

],

4930

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4931

"A String",

4932

],

4933

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4934

{ # Specification determining how headers are added to requests or responses.

4935

"headerName": "A String", # The name of the header.

4936

"headerValue": "A String", # The value of the header to add.

4937

"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.

4938

# The default value is false.

4939

},

4940

],

4941

"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.

4946

"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.

4947

# 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.

4948

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4949

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4950

"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.

4951

"A String",

4952

],

4953

"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.

4954

# Only one of routeAction or urlRedirect must be set.

4955

"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

4956

"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.

4957

# Default is false.

4958

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4959

"A String",

4960

],

4961

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4962

"A String",

4963

],

4964

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4965

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4966

"A String",

4967

],

4968

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4969

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4970

"A String",

4971

],

4972

"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.

4973

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4974

"A String",

4975

],

4976

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4977

},

4978

"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.

4979

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4980

"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.

4981

"httpStatus": 42, # The HTTP status code used to abort the request.

4982

# The value must be between 200 and 599 inclusive.

4983

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4984

# The value must be between 0.0 and 100.0 inclusive.

4985

},

4986

"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.

4987

"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.

4988

"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.

4989

"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

4990

},

4991

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4992

# The value must be between 0.0 and 100.0 inclusive.

4993

},

4994

},

4995

"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.

4996

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4997

},

4998

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4999

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5000

"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.

5001

# 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.

5002

"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.

5003

"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

5004

},

5005

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5006

# - 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.

5007

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5008

# -

5009

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5010

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5011

# - 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.

5012

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5013

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5014

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5015

# - 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.

5020

# If not specified, will use the largest timeout among all backend services associated with the route.

5021

"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.

5022

"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

5023

},

5024

"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.

5025

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5026

# The value must be between 1 and 255 characters.

5027

"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.

5028

# The value must be between 1 and 1024 characters.

5029

},

5030

"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.

5031

# 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.

5032

{ # 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

5033

"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.

5034

"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.

5035

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5036

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5037

{ # Specification determining how headers are added to requests or responses.

5038

"headerName": "A String", # The name of the header.

5039

"headerValue": "A String", # The value of the header to add.

5040

"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.

5041

# The default value is false.

5042

},

5043

],

5044

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5045

"A String",

5046

],

5047

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5048

{ # Specification determining how headers are added to requests or responses.

5049

"headerName": "A String", # The name of the header.

5050

"headerValue": "A String", # The value of the header to add.

5051

"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.

5052

# The default value is false.

5053

},

5054

],

5055

"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) .

5060

# 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.

5061

# 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.

5066

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5067

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5068

# If urlRedirect is specified, service or routeAction must not be set.

5069

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5070

# The value must be between 1 and 255 characters.

5071

"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.

5072

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5073

# The default is set to false.

5074

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5075

# 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.

5076

# The value must be between 1 and 1024 characters.

5077

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5078

# 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.

5079

# The value must be between 1 and 1024 characters.

5080

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5081

# Supported values are:

5082

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5083

# - FOUND, which corresponds to 302.

5084

# - SEE_OTHER which corresponds to 303.

5085

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5086

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5087

"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.

5088

# 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.

5093

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5094

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5095

"description": "A String", # The short description conveying the intent of this routeRule.

5096

# The description can have a maximum length of 1024 characters.

5097

"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.

5098

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5099

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5100

{ # Specification determining how headers are added to requests or responses.

5101

"headerName": "A String", # The name of the header.

5102

"headerValue": "A String", # The value of the header to add.

5103

"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.

5104

# The default value is false.

5105

},

5106

],

5107

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5108

"A String",

5109

],

5110

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5111

{ # Specification determining how headers are added to requests or responses.

5112

"headerName": "A String", # The name of the header.

5113

"headerValue": "A String", # The value of the header to add.

5114

"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.

5115

# The default value is false.

5116

},

5117

],

5118

"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",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5123

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5124

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5125

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5126

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

5127

},

5128

],

5129

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5130

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

5131

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5132

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5133

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5134

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5139

"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.

5140

# fullPathMatch must be between 1 and 1024 characters.

5141

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5142

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5143

{ # matchRule criteria for request header matches.

5144

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5145

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5146

"headerName": "A String", # The name of the HTTP header to match.

5147

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5148

# For matching a request's method, use the headerName ":method".

5149

"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.

5150

# The default setting is false.

5151

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5152

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5153

"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.

5154

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5155

"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.

5156

# For example for a range [-5, 0]

5157

# - -3 will match.

5158

# - 0 will not match.

5159

# - 0.25 will not match.

5160

# - -3someString will not match.

5161

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5162

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5163

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5164

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5165

},

5166

"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

5167

# 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.

5168

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5169

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5170

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5171

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5172

},

5173

],

5174

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5175

# The default value is false.

5176

# ignoreCase must not be used with regexMatch.

5177

"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.

5178

# 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.

5179

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5180

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5181

{ # 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.

5182

# 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.

5183

# 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.

5184

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5185

# This list must not be empty and can have at the most 64 entries.

5186

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5187

"name": "A String", # Name of metadata label.

5188

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5189

"value": "A String", # The value of the label must match the specified value.

5190

# value can have a maximum length of 1024 characters.

5191

},

5192

],

5193

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5194

# Supported values are:

5195

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5196

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5197

},

5198

],

5199

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5200

# The value must be between 1 and 1024 characters.

5201

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5202

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5203

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5204

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5205

# Only one of presentMatch, exactMatch or regexMatch must be set.

5206

"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.

5207

"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.

5208

# Only one of presentMatch, exactMatch or regexMatch must be set.

5209

"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

5210

# Only one of presentMatch, exactMatch or regexMatch must be set.

5211

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5212

},

5213

],

5214

"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

5215

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5216

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5217

},

5218

],

5219

"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.

5220

# 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.

5221

# 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.

5222

"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.

5223

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5224

"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

5225

"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.

5226

# Default is false.

5227

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5228

"A String",

5229

],

5230

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5231

"A String",

5232

],

5233

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5234

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5235

"A String",

5236

],

5237

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5238

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5239

"A String",

5240

],

5241

"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.

5242

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5243

"A String",

5244

],

5245

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5246

},

5247

"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.

5248

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5249

"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.

5250

"httpStatus": 42, # The HTTP status code used to abort the request.

5251

# The value must be between 200 and 599 inclusive.

5252

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5253

# The value must be between 0.0 and 100.0 inclusive.

5254

},

5255

"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.

5256

"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.

5257

"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.

5258

"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

5259

},

5260

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5261

# The value must be between 0.0 and 100.0 inclusive.

5262

},

5263

},

5264

"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.

5265

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5266

},

5267

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5268

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5269

"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.

5270

# 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.

5271

"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.

5272

"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

5273

},

5274

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5275

# - 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.

5276

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5277

# -

5278

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5279

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5280

# - 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.

5281

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5282

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5283

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5284

# - 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.

5289

# If not specified, will use the largest timeout among all backend services associated with the route.

5290

"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.

5291

"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

5292

},

5293

"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.

5294

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5295

# The value must be between 1 and 255 characters.

5296

"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.

5297

# The value must be between 1 and 1024 characters.

5298

},

5299

"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.

5300

# 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.

5301

{ # 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

5302

"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.

5303

"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.

5304

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5305

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5306

{ # Specification determining how headers are added to requests or responses.

5307

"headerName": "A String", # The name of the header.

5308

"headerValue": "A String", # The value of the header to add.

5309

"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.

5310

# The default value is false.

5311

},

5312

],

5313

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5314

"A String",

5315

],

5316

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5317

{ # Specification determining how headers are added to requests or responses.

5318

"headerName": "A String", # The name of the header.

5319

"headerValue": "A String", # The value of the header to add.

5320

"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.

5321

# The default value is false.

5322

},

5323

],

5324

"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) .

5329

# 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.

5330

# 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.

5335

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5336

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5337

# If urlRedirect is specified, service or routeAction must not be set.

5338

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5339

# The value must be between 1 and 255 characters.

5340

"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.

5341

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5342

# The default is set to false.

5343

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5344

# 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.

5345

# The value must be between 1 and 1024 characters.

5346

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5347

# 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.

5348

# The value must be between 1 and 1024 characters.

5349

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5350

# Supported values are:

5351

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5352

# - FOUND, which corresponds to 302.

5353

# - SEE_OTHER which corresponds to 303.

5354

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5355

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5356

"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.

5357

# 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.

5364

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5365

"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.

5366

{ # Message for the expected URL mappings.

5367

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

5368

"description": "A String", # Description of this test case.

5369

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

5370

"host": "A String", # Host portion of the URL.

5371

"path": "A String", # Path portion of the URL.

5372

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5373

},

5374

],

5375

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

Returns:

An object of the form:

5381

5382

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5383

"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.

5388

"testFailures": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5389

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5390

"actualService": "A String",

5391

"expectedService": "A String",

5392

"host": "A String",

5393

"path": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5394

},

5395

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5396

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Bu Sun Kim