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

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

[diff] [blame]

79

<p class="firstline">Retrieves the list of all UrlMap resources, regional and global, available to the specified project.</p>

80

81

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

82

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

83

Bu Sun Kim

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

[diff] [blame]

84

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

85

<p class="firstline">Deletes the specified UrlMap resource.</p>

86

87

<code><a href="#get">get(project, urlMap)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

89

Dan O'Meara

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

[diff] [blame]

90

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

91

<p class="firstline">Creates a UrlMap resource in the specified project using the data included in the request.</p>

92

Dan O'Meara

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

[diff] [blame]

93

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

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

94

<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.</p>

95

Bu Sun Kim

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

[diff] [blame^]

96

<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

97

<p class="firstline">Retrieves the list of UrlMap resources available to the specified project.</p>

98

99

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

100

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

101

Dan O'Meara

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

<p class="firstline">Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

106

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

109

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

110

<h3>Method Details</h3>

111

Bu Sun Kim

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

[diff] [blame^]

112

<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None)</code>

Dan O'Meara

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

[diff] [blame]

113

<pre>Retrieves the list of all UrlMap resources, regional and global, available to the specified project.

114

115

Args:

116

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

Dan O'Meara

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

[diff] [blame]

117

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

118

119

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

120

121

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.

122

Bu Sun Kim

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

[diff] [blame^]

123

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

Dan O'Meara

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

[diff] [blame]

124

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame^]

125

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

126

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

127

128

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.

129

130

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

131

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.

Dan O'Meara

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

[diff] [blame]

132

133

Returns:

134

An object of the form:

135

136

{

Bu Sun Kim

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

[diff] [blame^]

137

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

138

"items": { # A list of UrlMapsScopedList resources.

139

"a_key": { # Name of the scope containing this set of UrlMaps.

140

"urlMaps": [ # A list of UrlMaps contained in this scope.

Dan O'Meara

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

[diff] [blame]

141

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame^]

142

#

143

# Google Compute Engine has two URL Map resources:

144

#

145

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

146

#

147

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

148

#

149

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

150

#

151

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

152

#

153

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

154

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

155

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

156

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

157

"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

158

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

159

# Default is false.

160

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

161

"A String",

Dan O'Meara

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

[diff] [blame]

162

],

Bu Sun Kim

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

[diff] [blame^]

163

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

164

"A String",

165

],

166

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

167

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

168

"A String",

169

],

170

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

171

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

172

"A String",

173

],

174

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

175

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

176

"A String",

177

],

178

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

179

},

180

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

181

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

182

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

183

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

184

# The value must be between 200 and 599 inclusive.

185

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

186

# The value must be between 0.0 and 100.0 inclusive.

187

},

188

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

189

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

190

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

191

"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

192

},

193

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

194

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

195

},

196

},

Bu Sun Kim

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

[diff] [blame^]

197

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

198

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

199

},

200

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

201

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

202

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

203

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

204

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

205

"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

Dan O'Meara

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

[diff] [blame]

206

},

Bu Sun Kim

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

[diff] [blame^]

207

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

208

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

209

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

210

# -

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

"A String",

Dan O'Meara

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

[diff] [blame]

219

],

220

},

Bu Sun Kim

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

[diff] [blame^]

221

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

222

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

223

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

224

"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

225

},

226

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

227

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

Dan O'Meara

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

[diff] [blame]

228

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame^]

229

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

230

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

231

},

Bu Sun Kim

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

[diff] [blame^]

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

# The default value is false.

244

},

245

],

246

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

247

"A String",

248

],

249

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

250

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

251

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

252

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

253

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

254

# The default value is false.

255

},

256

],

257

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

262

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

263

# The value must be between 0 and 1000

Dan O'Meara

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

[diff] [blame]

264

},

265

],

Dan O'Meara

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

[diff] [blame]

266

},

Bu Sun Kim

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

[diff] [blame^]

267

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

268

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

269

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

270

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

271

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

272

# The value must be between 1 and 255 characters.

273

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

274

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

275

# The default is set to false.

276

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

277

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

278

# The value must be between 1 and 1024 characters.

279

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

280

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

281

# The value must be between 1 and 1024 characters.

282

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

283

# Supported values are:

284

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

285

# - FOUND, which corresponds to 302.

286

# - SEE_OTHER which corresponds to 303.

287

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

288

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

289

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

290

# The default is set to false.

291

},

292

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

293

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

294

#

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

# The default value is false.

304

},

305

],

306

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

307

"A String",

308

],

309

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

310

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

311

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

312

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

313

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

314

# The default value is false.

315

},

316

],

317

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

322

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

323

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

324

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

325

"A String",

326

],

327

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

328

},

329

],

330

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

331

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

332

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

333

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

334

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

335

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

336

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

337

"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

338

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

339

# Default is false.

340

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

341

"A String",

342

],

343

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

344

"A String",

345

],

346

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

347

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

348

"A String",

349

],

350

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

351

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

352

"A String",

353

],

354

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

355

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

356

"A String",

357

],

358

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

359

},

360

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

361

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

362

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

363

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

364

# The value must be between 200 and 599 inclusive.

365

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

366

# The value must be between 0.0 and 100.0 inclusive.

367

},

368

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

369

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

370

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

371

"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

372

},

373

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

374

# The value must be between 0.0 and 100.0 inclusive.

375

},

376

},

377

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

378

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

379

},

380

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

381

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

382

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

383

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

384

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

385

"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

386

},

387

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

388

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

389

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

390

# -

391

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

392

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

393

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

394

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

395

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

396

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

397

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

402

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

403

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

404

"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

405

},

406

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

407

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

408

# The value must be between 1 and 255 characters.

409

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

410

# The value must be between 1 and 1024 characters.

411

},

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

# The default value is false.

424

},

425

],

426

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

427

"A String",

428

],

429

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

430

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

431

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

432

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

433

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

434

# The default value is false.

435

},

436

],

437

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

442

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

443

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

448

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

449

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

450

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

451

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

452

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

453

# - compute.backendBuckets.use

454

# - compute.backendServices.use

455

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

456

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

457

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

458

# The value must be between 1 and 255 characters.

459

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

460

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

461

# The default is set to false.

462

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

463

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

464

# The value must be between 1 and 1024 characters.

465

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

466

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

467

# The value must be between 1 and 1024 characters.

468

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

469

# Supported values are:

470

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

471

# - FOUND, which corresponds to 302.

472

# - SEE_OTHER which corresponds to 303.

473

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

474

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

475

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

476

# The default is set to false.

477

},

478

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

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

# The default value is false.

487

},

488

],

489

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

490

"A String",

491

],

492

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

493

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

494

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

495

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

496

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

497

# The default value is false.

498

},

499

],

500

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

505

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

506

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

507

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

508

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

509

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

510

"A String",

511

],

512

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

513

# Only one of routeAction or urlRedirect must be set.

514

"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

515

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

516

# Default is false.

517

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

518

"A String",

519

],

520

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

521

"A String",

522

],

523

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

524

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

525

"A String",

526

],

527

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

528

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

529

"A String",

530

],

531

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

532

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

533

"A String",

534

],

535

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

536

},

537

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

538

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

539

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

540

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

541

# The value must be between 200 and 599 inclusive.

542

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

543

# The value must be between 0.0 and 100.0 inclusive.

544

},

545

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

546

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

547

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

548

"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

549

},

550

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

551

# The value must be between 0.0 and 100.0 inclusive.

552

},

553

},

554

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

555

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

556

},

557

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

558

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

559

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

560

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

561

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

562

"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

563

},

564

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

565

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

566

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

567

# -

568

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

569

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

570

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

571

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

572

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

573

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

574

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

579

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

580

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

581

"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

582

},

583

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

584

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

585

# The value must be between 1 and 255 characters.

586

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

587

# The value must be between 1 and 1024 characters.

588

},

589

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

590

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

591

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

592

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

593

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

594

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

595

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

596

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

597

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

598

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

599

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

600

# The default value is false.

601

},

602

],

603

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

604

"A String",

605

],

606

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

607

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

608

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

609

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

610

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

611

# The default value is false.

612

},

613

],

614

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

619

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

620

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

625

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

626

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

627

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

628

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

629

# The value must be between 1 and 255 characters.

630

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

631

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

632

# The default is set to false.

633

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

634

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

635

# The value must be between 1 and 1024 characters.

636

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

637

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

638

# The value must be between 1 and 1024 characters.

639

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

640

# Supported values are:

641

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

642

# - FOUND, which corresponds to 302.

643

# - SEE_OTHER which corresponds to 303.

644

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

645

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

646

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

647

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

652

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

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

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

661

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

662

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

663

# The default value is false.

664

},

665

],

666

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

667

"A String",

668

],

669

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

670

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

671

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

672

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

673

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

674

# The default value is false.

675

},

676

],

677

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

"A String",

],

},

"matchRules": [

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

683

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

684

# fullPathMatch must be between 1 and 1024 characters.

685

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

686

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

687

{ # matchRule criteria for request header matches.

688

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

689

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

690

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

691

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

692

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

693

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

694

# The default setting is false.

695

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

696

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

697

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

698

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

699

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

700

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

701

# - -3 will match.

702

# - 0 will not match.

703

# - 0.25 will not match.

704

# - -3someString will not match.

705

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

706

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

707

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

708

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

709

},

710

"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

711

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

712

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

713

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

714

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

715

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

716

},

717

],

718

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

719

# The default value is false.

720

# ignoreCase must not be used with regexMatch.

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

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

730

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

731

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

732

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

733

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

734

# value can have a maximum length of 1024 characters.

735

},

736

],

737

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

738

# Supported values are:

739

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

740

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

741

},

742

],

743

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

744

# The value must be between 1 and 1024 characters.

745

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

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

"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

754

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

755

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

756

},

757

],

758

"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

759

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

760

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

761

},

762

],

763

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

764

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

765

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

766

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

767

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

768

"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

769

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

770

# Default is false.

771

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

772

"A String",

773

],

774

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

775

"A String",

776

],

777

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

778

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

779

"A String",

780

],

781

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

782

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

783

"A String",

784

],

785

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

786

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

787

"A String",

788

],

789

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

790

},

791

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

792

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

793

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

794

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

795

# The value must be between 200 and 599 inclusive.

796

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

797

# The value must be between 0.0 and 100.0 inclusive.

798

},

799

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

800

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

801

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

802

"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

803

},

804

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

805

# The value must be between 0.0 and 100.0 inclusive.

806

},

807

},

808

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

809

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

810

},

811

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

812

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

813

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

814

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

815

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

816

"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

817

},

818

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

819

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

820

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

821

# -

822

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

823

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

824

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

825

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

826

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

827

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

828

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

833

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

834

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

835

"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

836

},

837

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

838

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

839

# The value must be between 1 and 255 characters.

840

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

841

# The value must be between 1 and 1024 characters.

842

},

843

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

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

# The default value is false.

855

},

856

],

857

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

858

"A String",

859

],

860

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

861

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

862

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

863

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

864

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

865

# The default value is false.

866

},

867

],

868

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

873

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

874

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

879

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

880

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

881

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

882

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

883

# The value must be between 1 and 255 characters.

884

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

885

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

886

# The default is set to false.

887

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

888

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

889

# The value must be between 1 and 1024 characters.

890

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

891

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

892

# The value must be between 1 and 1024 characters.

893

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

894

# Supported values are:

895

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

896

# - FOUND, which corresponds to 302.

897

# - SEE_OTHER which corresponds to 303.

898

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

899

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

900

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

901

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

908

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

909

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

910

{ # Message for the expected URL mappings.

911

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

912

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

913

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

914

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

915

},

916

],

917

},

Dan O'Meara

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

[diff] [blame]

918

],

Bu Sun Kim

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

[diff] [blame^]

919

"warning": { # Informational warning which replaces the list of backend services when the list is empty.

920

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

921

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

922

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

Dan O'Meara

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

[diff] [blame]

923

{

Bu Sun Kim

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

[diff] [blame^]

924

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

925

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

Dan O'Meara

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

[diff] [blame]

926

},

927

],

Bu Sun Kim

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

[diff] [blame^]

928

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

Dan O'Meara

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

[diff] [blame]

929

},

930

},

931

},

Bu Sun Kim

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

[diff] [blame^]

932

"kind": "compute#urlMapsAggregatedList", # Type of resource.

933

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

934

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

935

"warning": { # [Output Only] Informational warning message.

936

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

937

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

938

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

Dan O'Meara

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

[diff] [blame]

939

{

Bu Sun Kim

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

[diff] [blame^]

940

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

941

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

Dan O'Meara

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

[diff] [blame]

942

},

943

],

Bu Sun Kim

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

[diff] [blame^]

944

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

Dan O'Meara

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

[diff] [blame]

945

},

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>

951

<pre>Retrieves the next page of results.

952

953

Args:

954

previous_request: The request for the previous page. (required)

955

previous_response: The response from the request for the previous page. (required)

956

957

Returns:

Bu Sun Kim

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

[diff] [blame^]

958

A request object that you can call 'execute()' on to request the next

Dan O'Meara

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

[diff] [blame]

959

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

964

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

965

<pre>Deletes the specified UrlMap resource.

966

967

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

968

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

969

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

Bu Sun Kim

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

[diff] [blame]

970

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

971

972

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

973

974

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

975

976

Returns:

977

An object of the form:

978

Bu Sun Kim

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

[diff] [blame]

979

{ # Represents an Operation resource.

980

#

Dan O'Meara

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

[diff] [blame]

981

# Google Compute Engine has three Operation resources:

982

#

983

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

984

#

Bu Sun Kim

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

[diff] [blame]

985

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

986

#

987

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

988

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

989

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

990

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

Bu Sun Kim

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

[diff] [blame]

991

#

Dan O'Meara

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

[diff] [blame]

992

# 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^]

993

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

994

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

995

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

996

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

997

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

998

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

999

{

Bu Sun Kim

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

[diff] [blame^]

1000

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

1001

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

1002

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1003

},

1004

],

1005

},

Bu Sun Kim

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

[diff] [blame^]

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

{

1024

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

1025

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

1026

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

1027

{

1028

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

1029

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

1030

},

1031

],

1032

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

1033

},

1034

],

1035

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1041

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1042

1043

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1044

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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1045

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

1046

1047

Returns:

1048

An object of the form:

1049

Dan O'Meara

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

[diff] [blame]

1050

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame^]

1051

#

1052

# Google Compute Engine has two URL Map resources:

1053

#

1054

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

1055

#

1056

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

1057

#

1058

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

1059

#

1060

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

1061

#

1062

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

1063

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

1064

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

1065

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1066

"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

1067

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

1068

# Default is false.

1069

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

1070

"A String",

Dan O'Meara

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

[diff] [blame]

1071

],

Bu Sun Kim

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

[diff] [blame^]

1072

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

1073

"A String",

1074

],

1075

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

1076

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

1077

"A String",

1078

],

1079

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

1080

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

1081

"A String",

1082

],

1083

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

1084

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

1085

"A String",

1086

],

1087

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

1088

},

1089

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

1090

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

1091

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

1092

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

1093

# The value must be between 200 and 599 inclusive.

1094

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

1095

# The value must be between 0.0 and 100.0 inclusive.

1096

},

1097

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

1098

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

1099

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

1100

"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

1101

},

1102

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

1103

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

1104

},

1105

},

Bu Sun Kim

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

[diff] [blame^]

1106

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

1107

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

1108

},

1109

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

1110

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

1111

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

1112

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

1113

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

1114

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1115

},

Bu Sun Kim

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

[diff] [blame^]

1116

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

1117

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

1118

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

1119

# -

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

1126

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

1127

"A String",

Dan O'Meara

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

[diff] [blame]

1128

],

1129

},

Bu Sun Kim

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

[diff] [blame^]

1130

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

1131

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

1132

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

1133

"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

1134

},

1135

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

1136

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

Dan O'Meara

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

[diff] [blame]

1137

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame^]

1138

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

1139

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

1140

},

Bu Sun Kim

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

[diff] [blame^]

1141

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

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

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

1149

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

1150

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

1151

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

1152

# The default value is false.

1153

},

1154

],

1155

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

1156

"A String",

1157

],

1158

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

1159

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

1160

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

1161

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

1162

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

1163

# The default value is false.

1164

},

1165

],

1166

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

1171

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

1172

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1173

},

1174

],

Bu Sun Kim

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

[diff] [blame^]

1175

},

1176

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

1177

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

1178

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

1179

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

1180

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

1181

# The value must be between 1 and 255 characters.

1182

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

1183

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

1184

# The default is set to false.

1185

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

1186

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

1187

# The value must be between 1 and 1024 characters.

1188

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

1189

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

1190

# The value must be between 1 and 1024 characters.

1191

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

1192

# Supported values are:

1193

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

1194

# - FOUND, which corresponds to 302.

1195

# - SEE_OTHER which corresponds to 303.

1196

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

1197

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

1198

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

1199

# The default is set to false.

1200

},

1201

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

1202

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

1203

#

1204

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

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

# The default value is false.

1213

},

1214

],

1215

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

1216

"A String",

1217

],

1218

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

1219

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

1220

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

1221

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

1222

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

1223

# The default value is false.

1224

},

1225

],

1226

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

1231

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

1232

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

1233

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

1234

"A String",

1235

],

1236

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

1237

},

1238

],

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1246

"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

1247

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

1248

# Default is false.

1249

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

1250

"A String",

1251

],

1252

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

1253

"A String",

1254

],

1255

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

1256

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

1257

"A String",

1258

],

1259

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

1260

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

1261

"A String",

1262

],

1263

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

1264

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

1265

"A String",

1266

],

1267

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

1268

},

1269

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

1270

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

1271

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

1272

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

1273

# The value must be between 200 and 599 inclusive.

1274

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

1275

# The value must be between 0.0 and 100.0 inclusive.

1276

},

1277

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

1278

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

1279

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

1280

"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

1281

},

1282

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

1283

# The value must be between 0.0 and 100.0 inclusive.

1284

},

1285

},

1286

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

1287

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

1288

},

1289

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

1290

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

1291

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

1292

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

1293

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

1294

"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

1295

},

1296

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

1297

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

1298

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

1299

# -

1300

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

1301

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

1302

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

1303

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

1304

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

1305

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

1306

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

1311

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

1312

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

1313

"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

1314

},

1315

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

1316

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

1317

# The value must be between 1 and 255 characters.

1318

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

1319

# The value must be between 1 and 1024 characters.

1320

},

1321

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

1322

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

1323

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

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

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

1331

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

1332

# The default value is false.

1333

},

1334

],

1335

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

1336

"A String",

1337

],

1338

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

1339

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

1340

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

1341

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

1342

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

1343

# The default value is false.

1344

},

1345

],

1346

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

1351

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

1352

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

1357

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

1358

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

1359

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

1360

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

1361

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

1362

# - compute.backendBuckets.use

1363

# - compute.backendServices.use

1364

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

1365

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

1366

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

1367

# The value must be between 1 and 255 characters.

1368

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

1369

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

1370

# The default is set to false.

1371

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

1372

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

1373

# The value must be between 1 and 1024 characters.

1374

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

1375

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

1376

# The value must be between 1 and 1024 characters.

1377

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

1378

# Supported values are:

1379

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

1380

# - FOUND, which corresponds to 302.

1381

# - SEE_OTHER which corresponds to 303.

1382

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

1383

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

1384

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

1385

# The default is set to false.

1386

},

1387

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

1388

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

1389

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

1390

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

1391

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

1392

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

1393

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

1394

"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.

1395

# The default value is false.

1396

},

1397

],

1398

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1399

"A String",

1400

],

1401

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1402

{ # Specification determining how headers are added to requests or responses.

1403

"headerName": "A String", # The name of the header.

1404

"headerValue": "A String", # The value of the header to add.

1405

"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.

1406

# The default value is false.

1407

},

1408

],

1409

"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.

1414

"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.

1415

# 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.

1416

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1417

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1418

"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.

1419

"A String",

1420

],

1421

"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.

1422

# Only one of routeAction or urlRedirect must be set.

1423

"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

1424

"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.

1425

# Default is false.

1426

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1427

"A String",

1428

],

1429

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1430

"A String",

1431

],

1432

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1433

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1434

"A String",

1435

],

1436

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1437

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1438

"A String",

1439

],

1440

"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.

1441

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1442

"A String",

1443

],

1444

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1445

},

1446

"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.

1447

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1448

"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.

1449

"httpStatus": 42, # The HTTP status code used to abort the request.

1450

# The value must be between 200 and 599 inclusive.

1451

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1452

# The value must be between 0.0 and 100.0 inclusive.

1453

},

1454

"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.

1455

"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.

1456

"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.

1457

"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

1458

},

1459

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1460

# The value must be between 0.0 and 100.0 inclusive.

1461

},

1462

},

1463

"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.

1464

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1465

},

1466

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1467

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1468

"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.

1469

# 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.

1470

"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.

1471

"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

1472

},

1473

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1474

# - 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.

1475

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1476

# -

1477

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1478

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1479

# - 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.

1480

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1481

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1482

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1483

# - 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.

1488

# If not specified, will use the largest timeout among all backend services associated with the route.

1489

"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.

1490

"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

1491

},

1492

"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.

1493

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1494

# The value must be between 1 and 255 characters.

1495

"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.

1496

# The value must be between 1 and 1024 characters.

1497

},

1498

"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.

1499

# 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.

1500

{ # 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

1501

"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.

1502

"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.

1503

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1504

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1505

{ # Specification determining how headers are added to requests or responses.

1506

"headerName": "A String", # The name of the header.

1507

"headerValue": "A String", # The value of the header to add.

1508

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1509

# The default value is false.

1510

},

1511

],

1512

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1513

"A String",

1514

],

1515

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1516

{ # Specification determining how headers are added to requests or responses.

1517

"headerName": "A String", # The name of the header.

1518

"headerValue": "A String", # The value of the header to add.

1519

"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.

1520

# The default value is false.

1521

},

1522

],

1523

"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) .

1528

# 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.

1529

# 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.

1534

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1535

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1536

# If urlRedirect is specified, service or routeAction must not be set.

1537

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1538

# The value must be between 1 and 255 characters.

1539

"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.

1540

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1541

# The default is set to false.

1542

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1543

# 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.

1544

# The value must be between 1 and 1024 characters.

1545

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1546

# 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.

1547

# The value must be between 1 and 1024 characters.

1548

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1549

# Supported values are:

1550

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1551

# - FOUND, which corresponds to 302.

1552

# - SEE_OTHER which corresponds to 303.

1553

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1554

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1555

"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.

1556

# 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.

1561

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1562

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1563

"description": "A String", # The short description conveying the intent of this routeRule.

1564

# The description can have a maximum length of 1024 characters.

1565

"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.

1566

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1567

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1568

{ # Specification determining how headers are added to requests or responses.

1569

"headerName": "A String", # The name of the header.

1570

"headerValue": "A String", # The value of the header to add.

1571

"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.

1572

# The default value is false.

1573

},

1574

],

1575

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1576

"A String",

1577

],

1578

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1579

{ # Specification determining how headers are added to requests or responses.

1580

"headerName": "A String", # The name of the header.

1581

"headerValue": "A String", # The value of the header to add.

1582

"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.

1583

# The default value is false.

1584

},

1585

],

1586

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1592

"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.

1593

# fullPathMatch must be between 1 and 1024 characters.

1594

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1595

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1596

{ # matchRule criteria for request header matches.

1597

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1598

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1599

"headerName": "A String", # The name of the HTTP header to match.

1600

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1601

# For matching a request's method, use the headerName ":method".

1602

"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.

1603

# The default setting is false.

1604

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1605

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1606

"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.

1607

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1608

"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.

1609

# For example for a range [-5, 0]

1610

# - -3 will match.

1611

# - 0 will not match.

1612

# - 0.25 will not match.

1613

# - -3someString will not match.

1614

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1615

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1616

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1617

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1618

},

1619

"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

1620

# 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.

1621

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1622

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1623

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1624

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1625

},

1626

],

1627

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1628

# The default value is false.

1629

# ignoreCase must not be used with regexMatch.

1630

"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.

1631

# 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.

1632

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1633

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1634

{ # 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.

1635

# 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.

1636

# 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.

1637

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1638

# This list must not be empty and can have at the most 64 entries.

1639

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1640

"name": "A String", # Name of metadata label.

1641

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1642

"value": "A String", # The value of the label must match the specified value.

1643

# value can have a maximum length of 1024 characters.

1644

},

1645

],

1646

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1647

# Supported values are:

1648

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1649

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1650

},

1651

],

1652

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1653

# The value must be between 1 and 1024 characters.

1654

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1655

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1656

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1657

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1658

# Only one of presentMatch, exactMatch or regexMatch must be set.

1659

"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.

1660

"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.

1661

# Only one of presentMatch, exactMatch or regexMatch must be set.

1662

"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

1663

# Only one of presentMatch, exactMatch or regexMatch must be set.

1664

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1665

},

1666

],

1667

"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

1668

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1669

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1670

},

1671

],

1672

"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.

1673

# 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.

1674

# 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.

1675

"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.

1676

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1677

"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

1678

"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.

1679

# Default is false.

1680

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1681

"A String",

1682

],

1683

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1684

"A String",

1685

],

1686

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1687

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1688

"A String",

1689

],

1690

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1691

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1692

"A String",

1693

],

1694

"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.

1695

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1696

"A String",

1697

],

1698

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1699

},

1700

"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.

1701

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1702

"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.

1703

"httpStatus": 42, # The HTTP status code used to abort the request.

1704

# The value must be between 200 and 599 inclusive.

1705

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1706

# The value must be between 0.0 and 100.0 inclusive.

1707

},

1708

"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.

1709

"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.

1710

"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.

1711

"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

1712

},

1713

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1714

# The value must be between 0.0 and 100.0 inclusive.

1715

},

1716

},

1717

"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.

1718

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1719

},

1720

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1721

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1722

"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.

1723

# 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.

1724

"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.

1725

"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

1726

},

1727

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1728

# - 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.

1729

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1730

# -

1731

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1732

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1733

# - 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.

1734

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1735

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1736

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1737

# - 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.

1742

# If not specified, will use the largest timeout among all backend services associated with the route.

1743

"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.

1744

"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

1745

},

1746

"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.

1747

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1748

# The value must be between 1 and 255 characters.

1749

"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.

1750

# The value must be between 1 and 1024 characters.

1751

},

1752

"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.

1753

# 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.

1754

{ # 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

1755

"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.

1756

"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.

1757

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1758

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1759

{ # Specification determining how headers are added to requests or responses.

1760

"headerName": "A String", # The name of the header.

1761

"headerValue": "A String", # The value of the header to add.

1762

"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.

1763

# The default value is false.

1764

},

1765

],

1766

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1767

"A String",

1768

],

1769

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1770

{ # Specification determining how headers are added to requests or responses.

1771

"headerName": "A String", # The name of the header.

1772

"headerValue": "A String", # The value of the header to add.

1773

"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.

1774

# The default value is false.

1775

},

1776

],

1777

"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) .

1782

# 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.

1783

# 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.

1788

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1789

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1790

# If urlRedirect is specified, service or routeAction must not be set.

1791

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1792

# The value must be between 1 and 255 characters.

1793

"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.

1794

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1795

# The default is set to false.

1796

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1797

# 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.

1798

# The value must be between 1 and 1024 characters.

1799

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1800

# 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.

1801

# The value must be between 1 and 1024 characters.

1802

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1803

# Supported values are:

1804

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1805

# - FOUND, which corresponds to 302.

1806

# - SEE_OTHER which corresponds to 303.

1807

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1808

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1809

"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.

1810

# 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.

1817

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1818

"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.

1819

{ # Message for the expected URL mappings.

1820

"description": "A String", # Description of this test case.

1821

"host": "A String", # Host portion of the URL.

1822

"path": "A String", # Path portion of the URL.

1823

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1824

},

1825

],

1826

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1830

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1831

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1832

1833

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1834

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1835

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1836

The object takes the form of:

1837

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1838

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1839

#

1840

# Google Compute Engine has two URL Map resources:

1841

#

1842

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1843

#

1844

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1845

#

1846

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1847

#

1848

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1849

#

1850

# 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.

1851

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1852

"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.

1853

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

1854

"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

1855

"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.

1856

# Default is false.

1857

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1858

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1859

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1860

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1861

"A String",

1862

],

1863

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1864

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1865

"A String",

1866

],

1867

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1868

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1869

"A String",

1870

],

1871

"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.

1872

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1873

"A String",

1874

],

1875

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1876

},

1877

"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.

1878

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1879

"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.

1880

"httpStatus": 42, # The HTTP status code used to abort the request.

1881

# The value must be between 200 and 599 inclusive.

1882

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1883

# The value must be between 0.0 and 100.0 inclusive.

1884

},

1885

"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.

1886

"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.

1887

"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.

1888

"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

1889

},

1890

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1891

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1892

},

1893

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1894

"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.

1895

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1896

},

1897

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1898

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1899

"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.

1900

# 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.

1901

"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.

1902

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1903

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1904

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1905

# - 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.

1906

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1907

# -

1908

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1909

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1910

# - 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.

1911

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1912

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1913

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1914

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

1915

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1916

],

1917

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1918

"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.

1919

# If not specified, will use the largest timeout among all backend services associated with the route.

1920

"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.

1921

"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

1922

},

1923

"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.

1924

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1925

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1926

"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.

1927

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1928

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1929

"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.

1930

# 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.

1931

{ # 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

1932

"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.

1933

"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.

1934

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1935

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1936

{ # Specification determining how headers are added to requests or responses.

1937

"headerName": "A String", # The name of the header.

1938

"headerValue": "A String", # The value of the header to add.

1939

"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.

1940

# The default value is false.

1941

},

1942

],

1943

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1944

"A String",

1945

],

1946

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1947

{ # Specification determining how headers are added to requests or responses.

1948

"headerName": "A String", # The name of the header.

1949

"headerValue": "A String", # The value of the header to add.

1950

"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.

1951

# The default value is false.

1952

},

1953

],

1954

"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) .

1959

# 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.

1960

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1961

},

1962

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

1963

},

1964

"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.

1965

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1966

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1967

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1968

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1969

# The value must be between 1 and 255 characters.

1970

"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.

1971

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1972

# The default is set to false.

1973

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1974

# 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.

1975

# The value must be between 1 and 1024 characters.

1976

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1977

# 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.

1978

# The value must be between 1 and 1024 characters.

1979

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1980

# Supported values are:

1981

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1982

# - FOUND, which corresponds to 302.

1983

# - SEE_OTHER which corresponds to 303.

1984

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1985

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1986

"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.

1987

# The default is set to false.

1988

},

1989

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1990

"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.

1991

#

1992

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

1993

"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.

1994

# The headerAction specified here take effect after headerAction specified under pathMatcher.

1995

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1996

{ # Specification determining how headers are added to requests or responses.

1997

"headerName": "A String", # The name of the header.

1998

"headerValue": "A String", # The value of the header to add.

1999

"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.

2000

# The default value is false.

2001

},

2002

],

2003

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2004

"A String",

2005

],

2006

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2007

{ # Specification determining how headers are added to requests or responses.

2008

"headerName": "A String", # The name of the header.

2009

"headerValue": "A String", # The value of the header to add.

2010

"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.

2011

# The default value is false.

2012

},

2013

],

2014

"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.

2019

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2020

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2021

"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 ..

2022

"A String",

2023

],

2024

"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.

2025

},

2026

],

2027

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2028

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2029

"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.

2030

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2031

{ # 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.

2032

"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.

2033

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2034

"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

2035

"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.

2036

# Default is false.

2037

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2038

"A String",

2039

],

2040

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2041

"A String",

2042

],

2043

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2044

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2045

"A String",

2046

],

2047

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2048

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2049

"A String",

2050

],

2051

"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.

2052

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2053

"A String",

2054

],

2055

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2056

},

2057

"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.

2058

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2059

"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.

2060

"httpStatus": 42, # The HTTP status code used to abort the request.

2061

# The value must be between 200 and 599 inclusive.

2062

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2063

# The value must be between 0.0 and 100.0 inclusive.

2064

},

2065

"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.

2066

"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.

2067

"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.

2068

"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

2069

},

2070

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2071

# The value must be between 0.0 and 100.0 inclusive.

2072

},

2073

},

2074

"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.

2075

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2076

},

2077

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2078

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2079

"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.

2080

# 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.

2081

"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.

2082

"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

2083

},

2084

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2085

# - 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.

2086

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2087

# -

2088

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2089

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2090

# - 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.

2091

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2092

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2093

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2094

# - 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.

2099

# If not specified, will use the largest timeout among all backend services associated with the route.

2100

"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.

2101

"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

2102

},

2103

"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.

2104

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2105

# The value must be between 1 and 255 characters.

2106

"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.

2107

# The value must be between 1 and 1024 characters.

2108

},

2109

"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.

2110

# 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.

2111

{ # 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

2112

"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.

2113

"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.

2114

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2115

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2116

{ # Specification determining how headers are added to requests or responses.

2117

"headerName": "A String", # The name of the header.

2118

"headerValue": "A String", # The value of the header to add.

2119

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2120

# The default value is false.

2121

},

2122

],

2123

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2124

"A String",

2125

],

2126

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2127

{ # Specification determining how headers are added to requests or responses.

2128

"headerName": "A String", # The name of the header.

2129

"headerValue": "A String", # The value of the header to add.

2130

"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.

2131

# The default value is false.

2132

},

2133

],

2134

"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) .

2139

# 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.

2140

# 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:

2145

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2146

# - compute/v1/projects/project/global/backendServices/backendService

2147

# - 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.

2148

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2149

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2150

# - compute.backendBuckets.use

2151

# - compute.backendServices.use

2152

"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.

2153

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2154

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2155

# The value must be between 1 and 255 characters.

2156

"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.

2157

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2158

# The default is set to false.

2159

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2160

# 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.

2161

# The value must be between 1 and 1024 characters.

2162

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2163

# 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.

2164

# The value must be between 1 and 1024 characters.

2165

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2166

# Supported values are:

2167

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2168

# - FOUND, which corresponds to 302.

2169

# - SEE_OTHER which corresponds to 303.

2170

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2171

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2172

"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.

2173

# The default is set to false.

2174

},

2175

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2176

"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.

2177

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2178

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2179

{ # Specification determining how headers are added to requests or responses.

2180

"headerName": "A String", # The name of the header.

2181

"headerValue": "A String", # The value of the header to add.

2182

"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.

2183

# The default value is false.

2184

},

2185

],

2186

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2187

"A String",

2188

],

2189

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2190

{ # Specification determining how headers are added to requests or responses.

2191

"headerName": "A String", # The name of the header.

2192

"headerValue": "A String", # The value of the header to add.

2193

"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.

2194

# The default value is false.

2195

},

2196

],

2197

"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.

2202

"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.

2203

# 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.

2204

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2205

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2206

"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.

2207

"A String",

2208

],

2209

"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.

2210

# Only one of routeAction or urlRedirect must be set.

2211

"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

2212

"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.

2213

# Default is false.

2214

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2215

"A String",

2216

],

2217

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2218

"A String",

2219

],

2220

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2221

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2222

"A String",

2223

],

2224

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2225

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2226

"A String",

2227

],

2228

"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.

2229

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2230

"A String",

2231

],

2232

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2233

},

2234

"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.

2235

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2236

"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.

2237

"httpStatus": 42, # The HTTP status code used to abort the request.

2238

# The value must be between 200 and 599 inclusive.

2239

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2240

# The value must be between 0.0 and 100.0 inclusive.

2241

},

2242

"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.

2243

"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.

2244

"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.

2245

"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

2246

},

2247

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2248

# The value must be between 0.0 and 100.0 inclusive.

2249

},

2250

},

2251

"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.

2252

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2253

},

2254

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2255

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2256

"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.

2257

# 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.

2258

"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.

2259

"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

2260

},

2261

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2262

# - 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.

2263

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2264

# -

2265

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2266

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2267

# - 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.

2268

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2269

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2270

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2271

# - 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.

2276

# If not specified, will use the largest timeout among all backend services associated with the route.

2277

"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.

2278

"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

2279

},

2280

"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.

2281

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2282

# The value must be between 1 and 255 characters.

2283

"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.

2284

# The value must be between 1 and 1024 characters.

2285

},

2286

"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.

2287

# 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.

2288

{ # 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

2289

"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.

2290

"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.

2291

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2292

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2293

{ # Specification determining how headers are added to requests or responses.

2294

"headerName": "A String", # The name of the header.

2295

"headerValue": "A String", # The value of the header to add.

2296

"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.

2297

# The default value is false.

2298

},

2299

],

2300

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2301

"A String",

2302

],

2303

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2304

{ # Specification determining how headers are added to requests or responses.

2305

"headerName": "A String", # The name of the header.

2306

"headerValue": "A String", # The value of the header to add.

2307

"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.

2308

# The default value is false.

2309

},

2310

],

2311

"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) .

2316

# 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.

2317

# 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.

2322

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2323

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2324

# If urlRedirect is specified, service or routeAction must not be set.

2325

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2326

# The value must be between 1 and 255 characters.

2327

"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.

2328

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2329

# The default is set to false.

2330

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2331

# 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.

2332

# The value must be between 1 and 1024 characters.

2333

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2334

# 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.

2335

# The value must be between 1 and 1024 characters.

2336

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2337

# Supported values are:

2338

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2339

# - FOUND, which corresponds to 302.

2340

# - SEE_OTHER which corresponds to 303.

2341

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2342

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2343

"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.

2344

# 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.

2349

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2350

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2351

"description": "A String", # The short description conveying the intent of this routeRule.

2352

# The description can have a maximum length of 1024 characters.

2353

"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.

2354

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2355

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2356

{ # Specification determining how headers are added to requests or responses.

2357

"headerName": "A String", # The name of the header.

2358

"headerValue": "A String", # The value of the header to add.

2359

"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.

2360

# The default value is false.

2361

},

2362

],

2363

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2364

"A String",

2365

],

2366

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2367

{ # Specification determining how headers are added to requests or responses.

2368

"headerName": "A String", # The name of the header.

2369

"headerValue": "A String", # The value of the header to add.

2370

"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.

2371

# The default value is false.

2372

},

2373

],

2374

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2380

"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.

2381

# fullPathMatch must be between 1 and 1024 characters.

2382

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2383

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2384

{ # matchRule criteria for request header matches.

2385

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2386

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2387

"headerName": "A String", # The name of the HTTP header to match.

2388

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2389

# For matching a request's method, use the headerName ":method".

2390

"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.

2391

# The default setting is false.

2392

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2393

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2394

"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.

2395

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2396

"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.

2397

# For example for a range [-5, 0]

2398

# - -3 will match.

2399

# - 0 will not match.

2400

# - 0.25 will not match.

2401

# - -3someString will not match.

2402

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2403

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2404

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2405

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2406

},

2407

"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

2408

# 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.

2409

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2410

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2411

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2412

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2413

},

2414

],

2415

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2416

# The default value is false.

2417

# ignoreCase must not be used with regexMatch.

2418

"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.

2419

# 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.

2420

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2421

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2422

{ # 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.

2423

# 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.

2424

# 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.

2425

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2426

# This list must not be empty and can have at the most 64 entries.

2427

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2428

"name": "A String", # Name of metadata label.

2429

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2430

"value": "A String", # The value of the label must match the specified value.

2431

# value can have a maximum length of 1024 characters.

2432

},

2433

],

2434

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2435

# Supported values are:

2436

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2437

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2438

},

2439

],

2440

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2441

# The value must be between 1 and 1024 characters.

2442

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2443

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2444

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2445

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2446

# Only one of presentMatch, exactMatch or regexMatch must be set.

2447

"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.

2448

"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.

2449

# Only one of presentMatch, exactMatch or regexMatch must be set.

2450

"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

2451

# Only one of presentMatch, exactMatch or regexMatch must be set.

2452

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2453

},

2454

],

2455

"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

2456

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2457

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2458

},

2459

],

2460

"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.

2461

# 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.

2462

# 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.

2463

"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.

2464

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2465

"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

2466

"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.

2467

# Default is false.

2468

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2469

"A String",

2470

],

2471

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2472

"A String",

2473

],

2474

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2475

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2476

"A String",

2477

],

2478

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2479

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2480

"A String",

2481

],

2482

"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.

2483

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2484

"A String",

2485

],

2486

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2487

},

2488

"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.

2489

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2490

"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.

2491

"httpStatus": 42, # The HTTP status code used to abort the request.

2492

# The value must be between 200 and 599 inclusive.

2493

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2494

# The value must be between 0.0 and 100.0 inclusive.

2495

},

2496

"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.

2497

"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.

2498

"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.

2499

"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

2500

},

2501

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2502

# The value must be between 0.0 and 100.0 inclusive.

2503

},

2504

},

2505

"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.

2506

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2507

},

2508

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2509

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2510

"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.

2511

# 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.

2512

"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.

2513

"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

2514

},

2515

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2516

# - 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.

2517

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2518

# -

2519

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2520

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2521

# - 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.

2522

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2523

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2524

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2525

# - 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.

2530

# If not specified, will use the largest timeout among all backend services associated with the route.

2531

"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.

2532

"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

2533

},

2534

"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.

2535

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2536

# The value must be between 1 and 255 characters.

2537

"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.

2538

# The value must be between 1 and 1024 characters.

2539

},

2540

"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.

2541

# 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.

2542

{ # 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

2543

"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.

2544

"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.

2545

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2546

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2547

{ # Specification determining how headers are added to requests or responses.

2548

"headerName": "A String", # The name of the header.

2549

"headerValue": "A String", # The value of the header to add.

2550

"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.

2551

# The default value is false.

2552

},

2553

],

2554

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2555

"A String",

2556

],

2557

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2558

{ # Specification determining how headers are added to requests or responses.

2559

"headerName": "A String", # The name of the header.

2560

"headerValue": "A String", # The value of the header to add.

2561

"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.

2562

# The default value is false.

2563

},

2564

],

2565

"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) .

2570

# 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.

2571

# 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.

2576

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2577

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2578

# If urlRedirect is specified, service or routeAction must not be set.

2579

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2580

# The value must be between 1 and 255 characters.

2581

"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.

2582

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2583

# The default is set to false.

2584

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2585

# 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.

2586

# The value must be between 1 and 1024 characters.

2587

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2588

# 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.

2589

# The value must be between 1 and 1024 characters.

2590

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2591

# Supported values are:

2592

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2593

# - FOUND, which corresponds to 302.

2594

# - SEE_OTHER which corresponds to 303.

2595

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2596

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2597

"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.

2598

# 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.

2605

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2606

"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.

2607

{ # Message for the expected URL mappings.

2608

"description": "A String", # Description of this test case.

2609

"host": "A String", # Host portion of the URL.

2610

"path": "A String", # Path portion of the URL.

2611

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2612

},

2613

],

2614

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2615

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2616

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

2617

2618

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

2619

2620

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2621

2622

Returns:

2623

An object of the form:

2624

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2625

{ # Represents an Operation resource.

2626

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2627

# Google Compute Engine has three Operation resources:

2628

#

2629

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2630

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2631

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2632

#

2633

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2634

# - For global operations, use the `globalOperations` resource.

2635

# - For regional operations, use the `regionOperations` resource.

2636

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2637

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2638

# 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^]

2639

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2640

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2641

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2642

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2643

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2644

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2645

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2646

"code": "A String", # [Output Only] The error type identifier for this error.

2647

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2648

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2649

},

2650

],

2651

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2652

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2653

"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.

2654

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2655

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2656

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2657

"name": "A String", # [Output Only] Name of the operation.

2658

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2659

"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.

2660

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2661

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2662

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2663

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2664

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2665

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2666

"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.

2667

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2668

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2669

{

2670

"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.

2671

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2672

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2673

{

2674

"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).

2675

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2676

},

2677

],

2678

"message": "A String", # [Output Only] A human-readable description of the warning code.

2679

},

2680

],

2681

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2686

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2687

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2688

2689

Args:

2690

project: string, Project ID for this request. (required)

2691

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2692

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2693

The object takes the form of:

2694

2695

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2696

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2697

"path": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2698

}

2699

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2700

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

2701

2702

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

2703

2704

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2705

2706

Returns:

2707

An object of the form:

2708

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2709

{ # Represents an Operation resource.

2710

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2711

# Google Compute Engine has three Operation resources:

2712

#

2713

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2714

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2715

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2716

#

2717

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2718

# - For global operations, use the `globalOperations` resource.

2719

# - For regional operations, use the `regionOperations` resource.

2720

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2721

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2722

# 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^]

2723

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2724

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2725

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2726

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2727

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2728

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2729

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2730

"code": "A String", # [Output Only] The error type identifier for this error.

2731

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2732

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2733

},

2734

],

2735

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2736

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2737

"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.

2738

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2739

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2740

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2741

"name": "A String", # [Output Only] Name of the operation.

2742

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2743

"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.

2744

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2745

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2746

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2747

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2748

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2749

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2750

"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.

2751

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2752

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2753

{

2754

"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.

2755

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2756

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2757

{

2758

"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).

2759

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2760

},

2761

],

2762

"message": "A String", # [Output Only] A human-readable description of the warning code.

2763

},

2764

],

2765

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2770

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2771

<pre>Retrieves the list of UrlMap resources available to the specified project.

2772

2773

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2774

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2775

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 `<`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2776

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2777

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2778

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2779

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2780

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2781

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) ```

2782

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`)

2783

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2784

2785

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.

2786

2787

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2788

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2789

2790

Returns:

2791

An object of the form:

2792

2793

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2794

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2795

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2796

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2797

#

2798

# Google Compute Engine has two URL Map resources:

2799

#

2800

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2801

#

2802

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2803

#

2804

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2805

#

2806

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2807

#

2808

# 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.

2809

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2810

"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.

2811

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2812

"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

2813

"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.

2814

# Default is false.

2815

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2816

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2817

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2818

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2819

"A String",

2820

],

2821

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2822

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2823

"A String",

2824

],

2825

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2826

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2827

"A String",

2828

],

2829

"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.

2830

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2831

"A String",

2832

],

2833

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2834

},

2835

"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.

2836

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2837

"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.

2838

"httpStatus": 42, # The HTTP status code used to abort the request.

2839

# The value must be between 200 and 599 inclusive.

2840

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2841

# The value must be between 0.0 and 100.0 inclusive.

2842

},

2843

"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.

2844

"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.

2845

"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.

2846

"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

2847

},

2848

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2849

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2850

},

2851

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2852

"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.

2853

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2854

},

2855

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2856

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2857

"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.

2858

# 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.

2859

"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.

2860

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2861

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2862

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2863

# - 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.

2864

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2865

# -

2866

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2867

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2868

# - 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.

2869

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2870

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2871

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2872

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2873

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2874

],

2875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2876

"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.

2877

# If not specified, will use the largest timeout among all backend services associated with the route.

2878

"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.

2879

"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

2880

},

2881

"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.

2882

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2883

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2884

"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.

2885

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2886

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2887

"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.

2888

# 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.

2889

{ # 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

2890

"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.

2891

"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.

2892

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2893

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2894

{ # Specification determining how headers are added to requests or responses.

2895

"headerName": "A String", # The name of the header.

2896

"headerValue": "A String", # The value of the header to add.

2897

"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.

2898

# The default value is false.

2899

},

2900

],

2901

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2902

"A String",

2903

],

2904

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2905

{ # Specification determining how headers are added to requests or responses.

2906

"headerName": "A String", # The name of the header.

2907

"headerValue": "A String", # The value of the header to add.

2908

"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.

2909

# The default value is false.

2910

},

2911

],

2912

"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) .

2917

# 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.

2918

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2919

},

2920

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2921

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

2922

"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.

2923

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2924

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2925

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2926

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2927

# The value must be between 1 and 255 characters.

2928

"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.

2929

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2930

# The default is set to false.

2931

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2932

# 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.

2933

# The value must be between 1 and 1024 characters.

2934

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2935

# 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.

2936

# The value must be between 1 and 1024 characters.

2937

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2938

# Supported values are:

2939

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2940

# - FOUND, which corresponds to 302.

2941

# - SEE_OTHER which corresponds to 303.

2942

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2943

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2944

"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.

2945

# The default is set to false.

2946

},

2947

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2948

"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.

2949

#

2950

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2951

"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.

2952

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2953

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2954

{ # Specification determining how headers are added to requests or responses.

2955

"headerName": "A String", # The name of the header.

2956

"headerValue": "A String", # The value of the header to add.

2957

"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.

2958

# The default value is false.

2959

},

2960

],

2961

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2962

"A String",

2963

],

2964

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2965

{ # Specification determining how headers are added to requests or responses.

2966

"headerName": "A String", # The name of the header.

2967

"headerValue": "A String", # The value of the header to add.

2968

"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.

2969

# The default value is false.

2970

},

2971

],

2972

"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.

2977

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2978

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2979

"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 ..

2980

"A String",

2981

],

2982

"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.

2983

},

2984

],

2985

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2986

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2987

"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.

2988

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2989

{ # 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.

2990

"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.

2991

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

2992

"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

2993

"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.

2994

# Default is false.

2995

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2996

"A String",

2997

],

2998

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2999

"A String",

3000

],

3001

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3002

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3003

"A String",

3004

],

3005

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3006

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3007

"A String",

3008

],

3009

"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.

3010

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3011

"A String",

3012

],

3013

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3014

},

3015

"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.

3016

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3017

"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.

3018

"httpStatus": 42, # The HTTP status code used to abort the request.

3019

# The value must be between 200 and 599 inclusive.

3020

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3021

# The value must be between 0.0 and 100.0 inclusive.

3022

},

3023

"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.

3024

"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.

3025

"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.

3026

"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

3027

},

3028

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3029

# The value must be between 0.0 and 100.0 inclusive.

3030

},

3031

},

3032

"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.

3033

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3034

},

3035

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3036

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3037

"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.

3038

# 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.

3039

"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.

3040

"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

3041

},

3042

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3043

# - 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.

3044

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3045

# -

3046

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3047

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3048

# - 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.

3049

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3050

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3051

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3052

# - 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.

3057

# If not specified, will use the largest timeout among all backend services associated with the route.

3058

"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.

3059

"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

3060

},

3061

"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.

3062

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3063

# The value must be between 1 and 255 characters.

3064

"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.

3065

# The value must be between 1 and 1024 characters.

3066

},

3067

"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.

3068

# 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.

3069

{ # 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

3070

"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.

3071

"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.

3072

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3073

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3074

{ # Specification determining how headers are added to requests or responses.

3075

"headerName": "A String", # The name of the header.

3076

"headerValue": "A String", # The value of the header to add.

3077

"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.

3078

# The default value is false.

3079

},

3080

],

3081

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3082

"A String",

3083

],

3084

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3085

{ # Specification determining how headers are added to requests or responses.

3086

"headerName": "A String", # The name of the header.

3087

"headerValue": "A String", # The value of the header to add.

3088

"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.

3089

# The default value is false.

3090

},

3091

],

3092

"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) .

3097

# 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.

3098

# 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:

3103

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3104

# - compute/v1/projects/project/global/backendServices/backendService

3105

# - 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.

3106

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3107

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3108

# - compute.backendBuckets.use

3109

# - compute.backendServices.use

3110

"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.

3111

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3112

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3113

# The value must be between 1 and 255 characters.

3114

"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.

3115

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3116

# The default is set to false.

3117

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3118

# 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.

3119

# The value must be between 1 and 1024 characters.

3120

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3121

# 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.

3122

# The value must be between 1 and 1024 characters.

3123

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3124

# Supported values are:

3125

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3126

# - FOUND, which corresponds to 302.

3127

# - SEE_OTHER which corresponds to 303.

3128

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3129

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3130

"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.

3131

# The default is set to false.

3132

},

3133

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3134

"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.

3135

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3136

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3137

{ # Specification determining how headers are added to requests or responses.

3138

"headerName": "A String", # The name of the header.

3139

"headerValue": "A String", # The value of the header to add.

3140

"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.

3141

# The default value is false.

3142

},

3143

],

3144

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3145

"A String",

3146

],

3147

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3148

{ # Specification determining how headers are added to requests or responses.

3149

"headerName": "A String", # The name of the header.

3150

"headerValue": "A String", # The value of the header to add.

3151

"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.

3152

# The default value is false.

3153

},

3154

],

3155

"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.

3160

"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.

3161

# 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.

3162

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3163

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3164

"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.

3165

"A String",

3166

],

3167

"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.

3168

# Only one of routeAction or urlRedirect must be set.

3169

"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

3170

"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.

3171

# Default is false.

3172

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3173

"A String",

3174

],

3175

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3176

"A String",

3177

],

3178

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3179

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3180

"A String",

3181

],

3182

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3183

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3184

"A String",

3185

],

3186

"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.

3187

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3188

"A String",

3189

],

3190

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3191

},

3192

"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.

3193

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3194

"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.

3195

"httpStatus": 42, # The HTTP status code used to abort the request.

3196

# The value must be between 200 and 599 inclusive.

3197

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3198

# The value must be between 0.0 and 100.0 inclusive.

3199

},

3200

"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.

3201

"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.

3202

"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.

3203

"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

3204

},

3205

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3206

# The value must be between 0.0 and 100.0 inclusive.

3207

},

3208

},

3209

"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.

3210

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3211

},

3212

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3213

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3214

"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.

3215

# 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.

3216

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3217

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3218

},

3219

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3220

# - 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.

3221

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3222

# -

3223

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3224

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3225

# - 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.

3226

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3227

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3228

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3229

# - 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.

3234

# If not specified, will use the largest timeout among all backend services associated with the route.

3235

"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.

3236

"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

3237

},

3238

"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.

3239

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3240

# The value must be between 1 and 255 characters.

3241

"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.

3242

# The value must be between 1 and 1024 characters.

3243

},

3244

"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.

3245

# 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.

3246

{ # 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

3247

"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.

3248

"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.

3249

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3250

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3251

{ # Specification determining how headers are added to requests or responses.

3252

"headerName": "A String", # The name of the header.

3253

"headerValue": "A String", # The value of the header to add.

3254

"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.

3255

# The default value is false.

3256

},

3257

],

3258

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3259

"A String",

3260

],

3261

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3262

{ # Specification determining how headers are added to requests or responses.

3263

"headerName": "A String", # The name of the header.

3264

"headerValue": "A String", # The value of the header to add.

3265

"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.

3266

# The default value is false.

3267

},

3268

],

3269

"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) .

3274

# 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.

3275

# 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.

3280

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3281

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3282

# If urlRedirect is specified, service or routeAction must not be set.

3283

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3284

# The value must be between 1 and 255 characters.

3285

"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.

3286

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3287

# The default is set to false.

3288

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3289

# 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.

3290

# The value must be between 1 and 1024 characters.

3291

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3292

# 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.

3293

# The value must be between 1 and 1024 characters.

3294

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3295

# Supported values are:

3296

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3297

# - FOUND, which corresponds to 302.

3298

# - SEE_OTHER which corresponds to 303.

3299

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3300

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3301

"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.

3302

# 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.

3307

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3308

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3309

"description": "A String", # The short description conveying the intent of this routeRule.

3310

# The description can have a maximum length of 1024 characters.

3311

"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.

3312

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3313

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3314

{ # Specification determining how headers are added to requests or responses.

3315

"headerName": "A String", # The name of the header.

3316

"headerValue": "A String", # The value of the header to add.

3317

"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.

3318

# The default value is false.

3319

},

3320

],

3321

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3322

"A String",

3323

],

3324

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3325

{ # Specification determining how headers are added to requests or responses.

3326

"headerName": "A String", # The name of the header.

3327

"headerValue": "A String", # The value of the header to add.

3328

"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.

3329

# The default value is false.

3330

},

3331

],

3332

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3338

"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.

3339

# fullPathMatch must be between 1 and 1024 characters.

3340

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3341

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3342

{ # matchRule criteria for request header matches.

3343

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3344

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3345

"headerName": "A String", # The name of the HTTP header to match.

3346

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3347

# For matching a request's method, use the headerName ":method".

3348

"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.

3349

# The default setting is false.

3350

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3351

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3352

"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.

3353

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3354

"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.

3355

# For example for a range [-5, 0]

3356

# - -3 will match.

3357

# - 0 will not match.

3358

# - 0.25 will not match.

3359

# - -3someString will not match.

3360

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3361

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3362

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3363

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3364

},

3365

"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

3366

# 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.

3367

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3368

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3369

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3370

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3371

},

3372

],

3373

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3374

# The default value is false.

3375

# ignoreCase must not be used with regexMatch.

3376

"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.

3377

# 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.

3378

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3379

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3380

{ # 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.

3381

# 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.

3382

# 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.

3383

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3384

# This list must not be empty and can have at the most 64 entries.

3385

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3386

"name": "A String", # Name of metadata label.

3387

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3388

"value": "A String", # The value of the label must match the specified value.

3389

# value can have a maximum length of 1024 characters.

3390

},

3391

],

3392

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3393

# Supported values are:

3394

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3395

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3396

},

3397

],

3398

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3399

# The value must be between 1 and 1024 characters.

3400

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3401

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3402

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3403

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3404

# Only one of presentMatch, exactMatch or regexMatch must be set.

3405

"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.

3406

"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.

3407

# Only one of presentMatch, exactMatch or regexMatch must be set.

3408

"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

3409

# Only one of presentMatch, exactMatch or regexMatch must be set.

3410

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3411

},

3412

],

3413

"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

3414

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3415

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3416

},

3417

],

3418

"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.

3419

# 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.

3420

# 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.

3421

"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.

3422

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3423

"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

3424

"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.

3425

# Default is false.

3426

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3427

"A String",

3428

],

3429

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3430

"A String",

3431

],

3432

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3433

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3434

"A String",

3435

],

3436

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3437

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3438

"A String",

3439

],

3440

"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.

3441

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3442

"A String",

3443

],

3444

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3445

},

3446

"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.

3447

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3448

"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.

3449

"httpStatus": 42, # The HTTP status code used to abort the request.

3450

# The value must be between 200 and 599 inclusive.

3451

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3452

# The value must be between 0.0 and 100.0 inclusive.

3453

},

3454

"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.

3455

"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.

3456

"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.

3457

"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

3458

},

3459

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3460

# The value must be between 0.0 and 100.0 inclusive.

3461

},

3462

},

3463

"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.

3464

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3465

},

3466

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3467

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3468

"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.

3469

# 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.

3470

"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.

3471

"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

3472

},

3473

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3474

# - 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.

3475

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3476

# -

3477

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3478

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3479

# - 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.

3480

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3481

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3482

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3483

# - 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.

3488

# If not specified, will use the largest timeout among all backend services associated with the route.

3489

"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.

3490

"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

3491

},

3492

"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.

3493

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3494

# The value must be between 1 and 255 characters.

3495

"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.

3496

# The value must be between 1 and 1024 characters.

3497

},

3498

"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.

3499

# 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.

3500

{ # 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

3501

"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.

3502

"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.

3503

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3504

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3505

{ # Specification determining how headers are added to requests or responses.

3506

"headerName": "A String", # The name of the header.

3507

"headerValue": "A String", # The value of the header to add.

3508

"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.

3509

# The default value is false.

3510

},

3511

],

3512

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3513

"A String",

3514

],

3515

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3516

{ # Specification determining how headers are added to requests or responses.

3517

"headerName": "A String", # The name of the header.

3518

"headerValue": "A String", # The value of the header to add.

3519

"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.

3520

# The default value is false.

3521

},

3522

],

3523

"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) .

3528

# 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.

3529

# 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.

3534

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3535

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3536

# If urlRedirect is specified, service or routeAction must not be set.

3537

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3538

# The value must be between 1 and 255 characters.

3539

"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.

3540

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3541

# The default is set to false.

3542

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3543

# 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.

3544

# The value must be between 1 and 1024 characters.

3545

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3546

# 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.

3547

# The value must be between 1 and 1024 characters.

3548

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3549

# Supported values are:

3550

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3551

# - FOUND, which corresponds to 302.

3552

# - SEE_OTHER which corresponds to 303.

3553

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3554

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3555

"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.

3556

# 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.

3563

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3564

"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.

3565

{ # Message for the expected URL mappings.

3566

"description": "A String", # Description of this test case.

3567

"host": "A String", # Host portion of the URL.

3568

"path": "A String", # Path portion of the URL.

3569

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3570

},

3571

],

3572

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3573

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3574

"kind": "compute#urlMapList", # Type of resource.

3575

"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.

3576

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3577

"warning": { # [Output Only] Informational warning message.

3578

"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.

3579

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3580

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3581

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3582

"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).

3583

"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]

3584

},

3585

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3586

"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]

3587

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3593

<pre>Retrieves the next page of results.

3594

3595

Args:

3596

previous_request: The request for the previous page. (required)

3597

previous_response: The response from the request for the previous page. (required)

3598

3599

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3600

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3601

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]

3606

<code class="details" id="patch">patch(project, urlMap, body=None, requestId=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3607

<pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3608

3609

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3610

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

3611

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3612

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3613

The object takes the form of:

3614

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3615

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3616

#

3617

# Google Compute Engine has two URL Map resources:

3618

#

3619

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3620

#

3621

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3622

#

3623

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3624

#

3625

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3626

#

3627

# 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.

3628

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3629

"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.

3630

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3631

"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

3632

"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.

3633

# Default is false.

3634

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3635

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3636

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3637

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3638

"A String",

3639

],

3640

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3641

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3642

"A String",

3643

],

3644

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3645

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3646

"A String",

3647

],

3648

"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.

3649

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3650

"A String",

3651

],

3652

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3653

},

3654

"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.

3655

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3656

"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.

3657

"httpStatus": 42, # The HTTP status code used to abort the request.

3658

# The value must be between 200 and 599 inclusive.

3659

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3660

# The value must be between 0.0 and 100.0 inclusive.

3661

},

3662

"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.

3663

"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.

3664

"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.

3665

"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

3666

},

3667

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3668

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3669

},

3670

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3671

"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.

3672

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3673

},

3674

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3675

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3676

"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.

3677

# 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.

3678

"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.

3679

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3680

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3681

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3682

# - 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.

3683

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3684

# -

3685

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3686

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3687

# - 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.

3688

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3689

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3690

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3691

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3692

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3693

],

3694

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3695

"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.

3696

# If not specified, will use the largest timeout among all backend services associated with the route.

3697

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3698

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3699

},

3700

"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.

3701

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3702

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3703

"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.

3704

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3705

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3706

"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.

3707

# 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.

3708

{ # 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

3709

"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.

3710

"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.

3711

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3712

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3713

{ # Specification determining how headers are added to requests or responses.

3714

"headerName": "A String", # The name of the header.

3715

"headerValue": "A String", # The value of the header to add.

3716

"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.

3717

# The default value is false.

3718

},

3719

],

3720

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3721

"A String",

3722

],

3723

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3724

{ # Specification determining how headers are added to requests or responses.

3725

"headerName": "A String", # The name of the header.

3726

"headerValue": "A String", # The value of the header to add.

3727

"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.

3728

# The default value is false.

3729

},

3730

],

3731

"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) .

3736

# 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.

3737

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3738

},

3739

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

3740

},

3741

"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.

3742

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3743

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3744

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3745

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3746

# The value must be between 1 and 255 characters.

3747

"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.

3748

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3749

# The default is set to false.

3750

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3751

# 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.

3752

# The value must be between 1 and 1024 characters.

3753

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3754

# 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.

3755

# The value must be between 1 and 1024 characters.

3756

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3757

# Supported values are:

3758

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3759

# - FOUND, which corresponds to 302.

3760

# - SEE_OTHER which corresponds to 303.

3761

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3762

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3763

"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.

3764

# The default is set to false.

3765

},

3766

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3767

"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.

3768

#

3769

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3770

"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.

3771

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3772

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3773

{ # Specification determining how headers are added to requests or responses.

3774

"headerName": "A String", # The name of the header.

3775

"headerValue": "A String", # The value of the header to add.

3776

"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.

3777

# The default value is false.

3778

},

3779

],

3780

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3781

"A String",

3782

],

3783

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3784

{ # Specification determining how headers are added to requests or responses.

3785

"headerName": "A String", # The name of the header.

3786

"headerValue": "A String", # The value of the header to add.

3787

"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.

3788

# The default value is false.

3789

},

3790

],

3791

"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.

3796

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3797

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3798

"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 ..

3799

"A String",

3800

],

3801

"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.

3802

},

3803

],

3804

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3805

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3806

"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.

3807

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3808

{ # 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.

3809

"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.

3810

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

3811

"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

3812

"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.

3813

# Default is false.

3814

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3815

"A String",

3816

],

3817

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3818

"A String",

3819

],

3820

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3821

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3822

"A String",

3823

],

3824

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3825

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3826

"A String",

3827

],

3828

"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.

3829

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3830

"A String",

3831

],

3832

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3833

},

3834

"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.

3835

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3836

"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.

3837

"httpStatus": 42, # The HTTP status code used to abort the request.

3838

# The value must be between 200 and 599 inclusive.

3839

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3840

# The value must be between 0.0 and 100.0 inclusive.

3841

},

3842

"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.

3843

"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.

3844

"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.

3845

"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

3846

},

3847

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3848

# The value must be between 0.0 and 100.0 inclusive.

3849

},

3850

},

3851

"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.

3852

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3853

},

3854

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3855

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3856

"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.

3857

# 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.

3858

"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.

3859

"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

3860

},

3861

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3862

# - 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.

3863

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3864

# -

3865

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3866

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3867

# - 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.

3868

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3869

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3870

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3871

# - 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.

3876

# If not specified, will use the largest timeout among all backend services associated with the route.

3877

"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.

3878

"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

3879

},

3880

"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.

3881

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3882

# The value must be between 1 and 255 characters.

3883

"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.

3884

# The value must be between 1 and 1024 characters.

3885

},

3886

"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.

3887

# 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.

3888

{ # 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

3889

"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.

3890

"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.

3891

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3892

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3893

{ # Specification determining how headers are added to requests or responses.

3894

"headerName": "A String", # The name of the header.

3895

"headerValue": "A String", # The value of the header to add.

3896

"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.

3897

# The default value is false.

3898

},

3899

],

3900

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3901

"A String",

3902

],

3903

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3904

{ # Specification determining how headers are added to requests or responses.

3905

"headerName": "A String", # The name of the header.

3906

"headerValue": "A String", # The value of the header to add.

3907

"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.

3908

# The default value is false.

3909

},

3910

],

3911

"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) .

3916

# 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.

3917

# 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:

3922

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3923

# - compute/v1/projects/project/global/backendServices/backendService

3924

# - 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.

3925

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3926

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3927

# - compute.backendBuckets.use

3928

# - compute.backendServices.use

3929

"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.

3930

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3931

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3932

# The value must be between 1 and 255 characters.

3933

"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.

3934

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3935

# The default is set to false.

3936

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3937

# 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.

3938

# The value must be between 1 and 1024 characters.

3939

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3940

# 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.

3941

# The value must be between 1 and 1024 characters.

3942

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3943

# Supported values are:

3944

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3945

# - FOUND, which corresponds to 302.

3946

# - SEE_OTHER which corresponds to 303.

3947

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3948

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3949

"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.

3950

# The default is set to false.

3951

},

3952

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3953

"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.

3954

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3955

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3956

{ # Specification determining how headers are added to requests or responses.

3957

"headerName": "A String", # The name of the header.

3958

"headerValue": "A String", # The value of the header to add.

3959

"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.

3960

# The default value is false.

3961

},

3962

],

3963

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3964

"A String",

3965

],

3966

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3967

{ # Specification determining how headers are added to requests or responses.

3968

"headerName": "A String", # The name of the header.

3969

"headerValue": "A String", # The value of the header to add.

3970

"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.

3971

# The default value is false.

3972

},

3973

],

3974

"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.

3979

"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.

3980

# 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.

3981

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3982

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3983

"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.

3984

"A String",

3985

],

3986

"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.

3987

# Only one of routeAction or urlRedirect must be set.

3988

"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

3989

"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.

3990

# Default is false.

3991

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3992

"A String",

3993

],

3994

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3995

"A String",

3996

],

3997

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3998

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3999

"A String",

4000

],

4001

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4002

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4003

"A String",

4004

],

4005

"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.

4006

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4007

"A String",

4008

],

4009

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4010

},

4011

"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.

4012

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4013

"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.

4014

"httpStatus": 42, # The HTTP status code used to abort the request.

4015

# The value must be between 200 and 599 inclusive.

4016

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4017

# The value must be between 0.0 and 100.0 inclusive.

4018

},

4019

"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.

4020

"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.

4021

"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.

4022

"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

4023

},

4024

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4025

# The value must be between 0.0 and 100.0 inclusive.

4026

},

4027

},

4028

"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.

4029

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4030

},

4031

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4032

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4033

"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.

4034

# 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.

4035

"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.

4036

"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

4037

},

4038

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4039

# - 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.

4040

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4041

# -

4042

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4043

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4044

# - 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.

4045

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4046

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4047

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4048

# - 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.

4053

# If not specified, will use the largest timeout among all backend services associated with the route.

4054

"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.

4055

"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

4056

},

4057

"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.

4058

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4059

# The value must be between 1 and 255 characters.

4060

"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.

4061

# The value must be between 1 and 1024 characters.

4062

},

4063

"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.

4064

# 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.

4065

{ # 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

4066

"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.

4067

"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.

4068

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4069

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4070

{ # Specification determining how headers are added to requests or responses.

4071

"headerName": "A String", # The name of the header.

4072

"headerValue": "A String", # The value of the header to add.

4073

"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.

4074

# The default value is false.

4075

},

4076

],

4077

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4078

"A String",

4079

],

4080

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4081

{ # Specification determining how headers are added to requests or responses.

4082

"headerName": "A String", # The name of the header.

4083

"headerValue": "A String", # The value of the header to add.

4084

"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.

4085

# The default value is false.

4086

},

4087

],

4088

"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) .

4093

# 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.

4094

# 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.

4099

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4100

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4101

# If urlRedirect is specified, service or routeAction must not be set.

4102

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4103

# The value must be between 1 and 255 characters.

4104

"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.

4105

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4106

# The default is set to false.

4107

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4108

# 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.

4109

# The value must be between 1 and 1024 characters.

4110

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4111

# 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.

4112

# The value must be between 1 and 1024 characters.

4113

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4114

# Supported values are:

4115

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4116

# - FOUND, which corresponds to 302.

4117

# - SEE_OTHER which corresponds to 303.

4118

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4119

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4120

"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.

4121

# 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.

4126

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4127

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4128

"description": "A String", # The short description conveying the intent of this routeRule.

4129

# The description can have a maximum length of 1024 characters.

4130

"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.

4131

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4132

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4133

{ # Specification determining how headers are added to requests or responses.

4134

"headerName": "A String", # The name of the header.

4135

"headerValue": "A String", # The value of the header to add.

4136

"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.

4137

# The default value is false.

4138

},

4139

],

4140

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4141

"A String",

4142

],

4143

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4144

{ # Specification determining how headers are added to requests or responses.

4145

"headerName": "A String", # The name of the header.

4146

"headerValue": "A String", # The value of the header to add.

4147

"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.

4148

# The default value is false.

4149

},

4150

],

4151

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4157

"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.

4158

# fullPathMatch must be between 1 and 1024 characters.

4159

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4160

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4161

{ # matchRule criteria for request header matches.

4162

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4163

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4164

"headerName": "A String", # The name of the HTTP header to match.

4165

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4166

# For matching a request's method, use the headerName ":method".

4167

"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.

4168

# The default setting is false.

4169

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4170

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4171

"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.

4172

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4173

"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.

4174

# For example for a range [-5, 0]

4175

# - -3 will match.

4176

# - 0 will not match.

4177

# - 0.25 will not match.

4178

# - -3someString will not match.

4179

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4180

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4181

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4182

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4183

},

4184

"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

4185

# 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.

4186

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4187

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4188

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4189

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4190

},

4191

],

4192

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4193

# The default value is false.

4194

# ignoreCase must not be used with regexMatch.

4195

"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.

4196

# 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.

4197

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4198

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4199

{ # 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.

4200

# 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.

4201

# 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.

4202

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4203

# This list must not be empty and can have at the most 64 entries.

4204

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4205

"name": "A String", # Name of metadata label.

4206

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4207

"value": "A String", # The value of the label must match the specified value.

4208

# value can have a maximum length of 1024 characters.

4209

},

4210

],

4211

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4212

# Supported values are:

4213

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4214

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4215

},

4216

],

4217

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4218

# The value must be between 1 and 1024 characters.

4219

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4220

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4221

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4222

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4223

# Only one of presentMatch, exactMatch or regexMatch must be set.

4224

"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.

4225

"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.

4226

# Only one of presentMatch, exactMatch or regexMatch must be set.

4227

"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

4228

# Only one of presentMatch, exactMatch or regexMatch must be set.

4229

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4230

},

4231

],

4232

"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

4233

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4234

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4235

},

4236

],

4237

"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.

4238

# 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.

4239

# 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.

4240

"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.

4241

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4242

"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

4243

"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.

4244

# Default is false.

4245

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4246

"A String",

4247

],

4248

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4249

"A String",

4250

],

4251

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4252

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4253

"A String",

4254

],

4255

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4256

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4257

"A String",

4258

],

4259

"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.

4260

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4261

"A String",

4262

],

4263

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4264

},

4265

"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.

4266

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4267

"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.

4268

"httpStatus": 42, # The HTTP status code used to abort the request.

4269

# The value must be between 200 and 599 inclusive.

4270

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4271

# The value must be between 0.0 and 100.0 inclusive.

4272

},

4273

"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.

4274

"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.

4275

"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.

4276

"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

4277

},

4278

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4279

# The value must be between 0.0 and 100.0 inclusive.

4280

},

4281

},

4282

"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.

4283

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4284

},

4285

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4286

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4287

"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.

4288

# 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.

4289

"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.

4290

"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

4291

},

4292

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4293

# - 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.

4294

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4295

# -

4296

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4297

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4298

# - 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.

4299

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4300

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4301

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4302

# - 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.

4307

# If not specified, will use the largest timeout among all backend services associated with the route.

4308

"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.

4309

"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

4310

},

4311

"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.

4312

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4313

# The value must be between 1 and 255 characters.

4314

"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.

4315

# The value must be between 1 and 1024 characters.

4316

},

4317

"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.

4318

# 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.

4319

{ # 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

4320

"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.

4321

"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.

4322

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4323

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4324

{ # Specification determining how headers are added to requests or responses.

4325

"headerName": "A String", # The name of the header.

4326

"headerValue": "A String", # The value of the header to add.

4327

"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.

4328

# The default value is false.

4329

},

4330

],

4331

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4332

"A String",

4333

],

4334

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4335

{ # Specification determining how headers are added to requests or responses.

4336

"headerName": "A String", # The name of the header.

4337

"headerValue": "A String", # The value of the header to add.

4338

"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.

4339

# The default value is false.

4340

},

4341

],

4342

"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) .

4347

# 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.

4348

# 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.

4353

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4354

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4355

# If urlRedirect is specified, service or routeAction must not be set.

4356

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4357

# The value must be between 1 and 255 characters.

4358

"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.

4359

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4360

# The default is set to false.

4361

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4362

# 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.

4363

# The value must be between 1 and 1024 characters.

4364

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4365

# 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.

4366

# The value must be between 1 and 1024 characters.

4367

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4368

# Supported values are:

4369

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4370

# - FOUND, which corresponds to 302.

4371

# - SEE_OTHER which corresponds to 303.

4372

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4373

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4374

"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.

4375

# 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.

4382

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4383

"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.

4384

{ # Message for the expected URL mappings.

4385

"description": "A String", # Description of this test case.

4386

"host": "A String", # Host portion of the URL.

4387

"path": "A String", # Path portion of the URL.

4388

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4389

},

4390

],

4391

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4392

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4393

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

4394

4395

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

4396

4397

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4398

4399

Returns:

4400

An object of the form:

4401

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4402

{ # Represents an Operation resource.

4403

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4404

# Google Compute Engine has three Operation resources:

4405

#

4406

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4407

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4408

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4409

#

4410

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4411

# - For global operations, use the `globalOperations` resource.

4412

# - For regional operations, use the `regionOperations` resource.

4413

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4414

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4415

# 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^]

4416

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4417

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4418

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4419

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4420

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4421

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4422

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4423

"code": "A String", # [Output Only] The error type identifier for this error.

4424

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4425

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4426

},

4427

],

4428

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4429

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4430

"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.

4431

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4432

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4433

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4434

"name": "A String", # [Output Only] Name of the operation.

4435

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4436

"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.

4437

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4438

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4439

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4440

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4441

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4442

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4443

"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.

4444

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4445

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4446

{

4447

"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.

4448

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4449

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4450

{

4451

"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).

4452

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4453

},

4454

],

4455

"message": "A String", # [Output Only] A human-readable description of the warning code.

4456

},

4457

],

4458

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4463

<code class="details" id="update">update(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

4464

<pre>Updates the specified UrlMap resource with the data included in the request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4465

4466

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

4467

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4468

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4469

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4470

The object takes the form of:

4471

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4472

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4473

#

4474

# Google Compute Engine has two URL Map resources:

4475

#

4476

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4477

#

4478

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4479

#

4480

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4481

#

4482

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4483

#

4484

# 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.

4485

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4486

"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.

4487

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4488

"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

4489

"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.

4490

# Default is false.

4491

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4492

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4493

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4494

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4495

"A String",

4496

],

4497

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4498

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4499

"A String",

4500

],

4501

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4502

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4503

"A String",

4504

],

4505

"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.

4506

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4507

"A String",

4508

],

4509

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4510

},

4511

"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.

4512

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4513

"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.

4514

"httpStatus": 42, # The HTTP status code used to abort the request.

4515

# The value must be between 200 and 599 inclusive.

4516

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4517

# The value must be between 0.0 and 100.0 inclusive.

4518

},

4519

"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.

4520

"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.

4521

"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.

4522

"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

4523

},

4524

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4525

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4526

},

4527

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4528

"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.

4529

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4530

},

4531

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4532

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4533

"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.

4534

# 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.

4535

"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.

4536

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4537

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4538

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4539

# - 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.

4540

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4541

# -

4542

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4543

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4544

# - 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.

4545

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4546

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4547

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4548

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4549

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4550

],

4551

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4552

"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.

4553

# If not specified, will use the largest timeout among all backend services associated with the route.

4554

"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.

4555

"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

4556

},

4557

"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.

4558

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4559

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4560

"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.

4561

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4562

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4563

"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.

4564

# 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.

4565

{ # 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

4566

"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.

4567

"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.

4568

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4569

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4570

{ # Specification determining how headers are added to requests or responses.

4571

"headerName": "A String", # The name of the header.

4572

"headerValue": "A String", # The value of the header to add.

4573

"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.

4574

# The default value is false.

4575

},

4576

],

4577

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4578

"A String",

4579

],

4580

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4581

{ # Specification determining how headers are added to requests or responses.

4582

"headerName": "A String", # The name of the header.

4583

"headerValue": "A String", # The value of the header to add.

4584

"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.

4585

# The default value is false.

4586

},

4587

],

4588

"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) .

4593

# 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.

4594

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4595

},

4596

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

4597

},

4598

"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.

4599

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4600

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4601

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4602

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4603

# The value must be between 1 and 255 characters.

4604

"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.

4605

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4606

# The default is set to false.

4607

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4608

# 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.

4609

# The value must be between 1 and 1024 characters.

4610

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4611

# 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.

4612

# The value must be between 1 and 1024 characters.

4613

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4614

# Supported values are:

4615

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4616

# - FOUND, which corresponds to 302.

4617

# - SEE_OTHER which corresponds to 303.

4618

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4619

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4620

"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.

4621

# The default is set to false.

4622

},

4623

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4624

"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.

4625

#

4626

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4627

"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.

4628

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4629

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4630

{ # Specification determining how headers are added to requests or responses.

4631

"headerName": "A String", # The name of the header.

4632

"headerValue": "A String", # The value of the header to add.

4633

"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.

4634

# The default value is false.

4635

},

4636

],

4637

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4638

"A String",

4639

],

4640

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4641

{ # Specification determining how headers are added to requests or responses.

4642

"headerName": "A String", # The name of the header.

4643

"headerValue": "A String", # The value of the header to add.

4644

"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.

4645

# The default value is false.

4646

},

4647

],

4648

"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.

4653

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4654

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4655

"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 ..

4656

"A String",

4657

],

4658

"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.

4659

},

4660

],

4661

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4662

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4663

"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.

4664

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4665

{ # 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.

4666

"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.

4667

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

4668

"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

4669

"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.

4670

# Default is false.

4671

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4672

"A String",

4673

],

4674

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4675

"A String",

4676

],

4677

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4678

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4679

"A String",

4680

],

4681

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4682

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4683

"A String",

4684

],

4685

"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.

4686

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4687

"A String",

4688

],

4689

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4690

},

4691

"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.

4692

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4693

"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.

4694

"httpStatus": 42, # The HTTP status code used to abort the request.

4695

# The value must be between 200 and 599 inclusive.

4696

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4697

# The value must be between 0.0 and 100.0 inclusive.

4698

},

4699

"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.

4700

"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.

4701

"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.

4702

"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

4703

},

4704

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4705

# The value must be between 0.0 and 100.0 inclusive.

4706

},

4707

},

4708

"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.

4709

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4710

},

4711

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4712

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4713

"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.

4714

# 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.

4715

"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.

4716

"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

4717

},

4718

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4719

# - 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.

4720

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4721

# -

4722

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4723

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4724

# - 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.

4725

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4726

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4727

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4728

# - 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.

4733

# If not specified, will use the largest timeout among all backend services associated with the route.

4734

"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.

4735

"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

4736

},

4737

"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.

4738

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4739

# The value must be between 1 and 255 characters.

4740

"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.

4741

# The value must be between 1 and 1024 characters.

4742

},

4743

"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.

4744

# 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.

4745

{ # 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

4746

"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.

4747

"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.

4748

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4749

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4750

{ # Specification determining how headers are added to requests or responses.

4751

"headerName": "A String", # The name of the header.

4752

"headerValue": "A String", # The value of the header to add.

4753

"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.

4754

# The default value is false.

4755

},

4756

],

4757

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4758

"A String",

4759

],

4760

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4761

{ # Specification determining how headers are added to requests or responses.

4762

"headerName": "A String", # The name of the header.

4763

"headerValue": "A String", # The value of the header to add.

4764

"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.

4765

# The default value is false.

4766

},

4767

],

4768

"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) .

4773

# 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.

4774

# 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:

4779

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4780

# - compute/v1/projects/project/global/backendServices/backendService

4781

# - 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.

4782

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4783

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4784

# - compute.backendBuckets.use

4785

# - compute.backendServices.use

4786

"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.

4787

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4788

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4789

# The value must be between 1 and 255 characters.

4790

"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.

4791

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4792

# The default is set to false.

4793

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4794

# 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.

4795

# The value must be between 1 and 1024 characters.

4796

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4797

# 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.

4798

# The value must be between 1 and 1024 characters.

4799

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4800

# Supported values are:

4801

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4802

# - FOUND, which corresponds to 302.

4803

# - SEE_OTHER which corresponds to 303.

4804

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4805

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4806

"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.

4807

# The default is set to false.

4808

},

4809

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4810

"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.

4811

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4812

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4813

{ # Specification determining how headers are added to requests or responses.

4814

"headerName": "A String", # The name of the header.

4815

"headerValue": "A String", # The value of the header to add.

4816

"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.

4817

# The default value is false.

4818

},

4819

],

4820

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4821

"A String",

4822

],

4823

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4824

{ # Specification determining how headers are added to requests or responses.

4825

"headerName": "A String", # The name of the header.

4826

"headerValue": "A String", # The value of the header to add.

4827

"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.

4828

# The default value is false.

4829

},

4830

],

4831

"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.

4836

"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.

4837

# 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.

4838

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4839

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4840

"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.

4841

"A String",

4842

],

4843

"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.

4844

# Only one of routeAction or urlRedirect must be set.

4845

"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

4846

"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.

4847

# Default is false.

4848

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4849

"A String",

4850

],

4851

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4852

"A String",

4853

],

4854

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4855

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4856

"A String",

4857

],

4858

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4859

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4860

"A String",

4861

],

4862

"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.

4863

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4864

"A String",

4865

],

4866

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4867

},

4868

"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.

4869

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4870

"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.

4871

"httpStatus": 42, # The HTTP status code used to abort the request.

4872

# The value must be between 200 and 599 inclusive.

4873

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4874

# The value must be between 0.0 and 100.0 inclusive.

4875

},

4876

"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.

4877

"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.

4878

"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.

4879

"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

4880

},

4881

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4882

# The value must be between 0.0 and 100.0 inclusive.

4883

},

4884

},

4885

"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.

4886

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4887

},

4888

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4889

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4890

"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.

4891

# 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.

4892

"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.

4893

"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

4894

},

4895

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4896

# - 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.

4897

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4898

# -

4899

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4900

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4901

# - 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.

4902

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4903

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4904

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4905

# - 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.

4910

# If not specified, will use the largest timeout among all backend services associated with the route.

4911

"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.

4912

"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

4913

},

4914

"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.

4915

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4916

# The value must be between 1 and 255 characters.

4917

"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.

4918

# The value must be between 1 and 1024 characters.

4919

},

4920

"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.

4921

# 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.

4922

{ # 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

4923

"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.

4924

"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.

4925

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4926

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4927

{ # Specification determining how headers are added to requests or responses.

4928

"headerName": "A String", # The name of the header.

4929

"headerValue": "A String", # The value of the header to add.

4930

"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.

4931

# The default value is false.

4932

},

4933

],

4934

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4935

"A String",

4936

],

4937

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4938

{ # Specification determining how headers are added to requests or responses.

4939

"headerName": "A String", # The name of the header.

4940

"headerValue": "A String", # The value of the header to add.

4941

"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.

4942

# The default value is false.

4943

},

4944

],

4945

"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) .

4950

# 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.

4951

# 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.

4956

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4957

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4958

# If urlRedirect is specified, service or routeAction must not be set.

4959

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4960

# The value must be between 1 and 255 characters.

4961

"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.

4962

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4963

# The default is set to false.

4964

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4965

# 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.

4966

# The value must be between 1 and 1024 characters.

4967

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4968

# 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.

4969

# The value must be between 1 and 1024 characters.

4970

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4971

# Supported values are:

4972

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4973

# - FOUND, which corresponds to 302.

4974

# - SEE_OTHER which corresponds to 303.

4975

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4976

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4977

"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.

4978

# 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.

4983

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4984

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4985

"description": "A String", # The short description conveying the intent of this routeRule.

4986

# The description can have a maximum length of 1024 characters.

4987

"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.

4988

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4989

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4990

{ # Specification determining how headers are added to requests or responses.

4991

"headerName": "A String", # The name of the header.

4992

"headerValue": "A String", # The value of the header to add.

4993

"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.

4994

# The default value is false.

4995

},

4996

],

4997

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4998

"A String",

4999

],

5000

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5001

{ # Specification determining how headers are added to requests or responses.

5002

"headerName": "A String", # The name of the header.

5003

"headerValue": "A String", # The value of the header to add.

5004

"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.

5005

# The default value is false.

5006

},

5007

],

5008

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5014

"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.

5015

# fullPathMatch must be between 1 and 1024 characters.

5016

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5017

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5018

{ # matchRule criteria for request header matches.

5019

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5020

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5021

"headerName": "A String", # The name of the HTTP header to match.

5022

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5023

# For matching a request's method, use the headerName ":method".

5024

"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.

5025

# The default setting is false.

5026

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5027

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5028

"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.

5029

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5030

"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.

5031

# For example for a range [-5, 0]

5032

# - -3 will match.

5033

# - 0 will not match.

5034

# - 0.25 will not match.

5035

# - -3someString will not match.

5036

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5037

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5038

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5039

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5040

},

5041

"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

5042

# 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.

5043

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5044

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5045

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5046

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5047

},

5048

],

5049

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5050

# The default value is false.

5051

# ignoreCase must not be used with regexMatch.

5052

"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.

5053

# 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.

5054

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5055

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5056

{ # 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.

5057

# 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.

5058

# 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.

5059

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5060

# This list must not be empty and can have at the most 64 entries.

5061

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5062

"name": "A String", # Name of metadata label.

5063

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5064

"value": "A String", # The value of the label must match the specified value.

5065

# value can have a maximum length of 1024 characters.

5066

},

5067

],

5068

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5069

# Supported values are:

5070

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5071

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5072

},

5073

],

5074

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5075

# The value must be between 1 and 1024 characters.

5076

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5077

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5078

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5079

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5080

# Only one of presentMatch, exactMatch or regexMatch must be set.

5081

"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.

5082

"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.

5083

# Only one of presentMatch, exactMatch or regexMatch must be set.

5084

"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

5085

# Only one of presentMatch, exactMatch or regexMatch must be set.

5086

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5087

},

5088

],

5089

"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

5090

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5091

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5092

},

5093

],

5094

"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.

5095

# 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.

5096

# 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.

5097

"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.

5098

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5099

"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

5100

"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.

5101

# Default is false.

5102

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5103

"A String",

5104

],

5105

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5106

"A String",

5107

],

5108

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5109

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5110

"A String",

5111

],

5112

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5113

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5114

"A String",

5115

],

5116

"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.

5117

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5118

"A String",

5119

],

5120

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5121

},

5122

"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.

5123

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5124

"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.

5125

"httpStatus": 42, # The HTTP status code used to abort the request.

5126

# The value must be between 200 and 599 inclusive.

5127

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5128

# The value must be between 0.0 and 100.0 inclusive.

5129

},

5130

"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.

5131

"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.

5132

"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.

5133

"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

5134

},

5135

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5136

# The value must be between 0.0 and 100.0 inclusive.

5137

},

5138

},

5139

"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.

5140

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5141

},

5142

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5143

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5144

"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.

5145

# 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.

5146

"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.

5147

"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

5148

},

5149

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5150

# - 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.

5151

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5152

# -

5153

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5154

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5155

# - 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.

5156

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5157

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5158

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5159

# - 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.

5164

# If not specified, will use the largest timeout among all backend services associated with the route.

5165

"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.

5166

"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

5167

},

5168

"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.

5169

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5170

# The value must be between 1 and 255 characters.

5171

"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.

5172

# The value must be between 1 and 1024 characters.

5173

},

5174

"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.

5175

# 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.

5176

{ # 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

5177

"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.

5178

"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.

5179

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5180

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5181

{ # Specification determining how headers are added to requests or responses.

5182

"headerName": "A String", # The name of the header.

5183

"headerValue": "A String", # The value of the header to add.

5184

"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.

5185

# The default value is false.

5186

},

5187

],

5188

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5189

"A String",

5190

],

5191

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5192

{ # Specification determining how headers are added to requests or responses.

5193

"headerName": "A String", # The name of the header.

5194

"headerValue": "A String", # The value of the header to add.

5195

"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.

5196

# The default value is false.

5197

},

5198

],

5199

"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) .

5204

# 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.

5205

# 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.

5210

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5211

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5212

# If urlRedirect is specified, service or routeAction must not be set.

5213

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5214

# The value must be between 1 and 255 characters.

5215

"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.

5216

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5217

# The default is set to false.

5218

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5219

# 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.

5220

# The value must be between 1 and 1024 characters.

5221

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5222

# 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.

5223

# The value must be between 1 and 1024 characters.

5224

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5225

# Supported values are:

5226

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5227

# - FOUND, which corresponds to 302.

5228

# - SEE_OTHER which corresponds to 303.

5229

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5230

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5231

"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.

5232

# 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.

5239

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5240

"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.

5241

{ # Message for the expected URL mappings.

5242

"description": "A String", # Description of this test case.

5243

"host": "A String", # Host portion of the URL.

5244

"path": "A String", # Path portion of the URL.

5245

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5246

},

5247

],

5248

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5249

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5250

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

5251

5252

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

5253

5254

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5255

5256

Returns:

5257

An object of the form:

5258

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5259

{ # Represents an Operation resource.

5260

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5261

# Google Compute Engine has three Operation resources:

5262

#

5263

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5264

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5265

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5266

#

5267

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5268

# - For global operations, use the `globalOperations` resource.

5269

# - For regional operations, use the `regionOperations` resource.

5270

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5271

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5272

# 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^]

5273

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5274

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5275

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5276

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5277

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5278

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5279

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5280

"code": "A String", # [Output Only] The error type identifier for this error.

5281

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5282

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5283

},

5284

],

5285

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5286

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5287

"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.

5288

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5289

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5290

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5291

"name": "A String", # [Output Only] Name of the operation.

5292

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5293

"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.

5294

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5295

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5296

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5297

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5298

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5299

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5300

"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.

5301

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5302

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5303

{

5304

"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.

5305

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5306

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5307

{

5308

"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).

5309

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5310

},

5311

],

5312

"message": "A String", # [Output Only] A human-readable description of the warning code.

5313

},

5314

],

5315

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5320

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5321

<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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5322

5323

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5324

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5325

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5326

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5327

The object takes the form of:

5328

5329

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5330

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5331

#

5332

# Google Compute Engine has two URL Map resources:

5333

#

5334

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5335

#

5336

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5337

#

5338

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5339

#

5340

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5341

#

5342

# 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.

5343

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5344

"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.

5345

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

5346

"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

5347

"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.

5348

# Default is false.

5349

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5350

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5351

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5352

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5353

"A String",

5354

],

5355

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5356

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5357

"A String",

5358

],

5359

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5360

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5361

"A String",

5362

],

5363

"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.

5364

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5365

"A String",

5366

],

5367

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5368

},

5369

"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.

5370

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5371

"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.

5372

"httpStatus": 42, # The HTTP status code used to abort the request.

5373

# The value must be between 200 and 599 inclusive.

5374

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5375

# The value must be between 0.0 and 100.0 inclusive.

5376

},

5377

"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.

5378

"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.

5379

"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.

5380

"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

5381

},

5382

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5383

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5384

},

5385

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5386

"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.

5387

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5388

},

5389

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5390

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5391

"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.

5392

# 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.

5393

"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.

5394

"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

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5395

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5396

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5397

# - 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.

5398

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5399

# -

5400

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5401

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5402

# - 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.

5403

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5404

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5405

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5406

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5407

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5408

],

5409

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5410

"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.

5411

# If not specified, will use the largest timeout among all backend services associated with the route.

5412

"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.

5413

"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

5414

},

5415

"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.

5416

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5417

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5418

"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.

5419

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5420

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5421

"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.

5422

# 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.

5423

{ # 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

5424

"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.

5425

"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.

5426

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5427

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5428

{ # Specification determining how headers are added to requests or responses.

5429

"headerName": "A String", # The name of the header.

5430

"headerValue": "A String", # The value of the header to add.

5431

"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.

5432

# The default value is false.

5433

},

5434

],

5435

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5436

"A String",

5437

],

5438

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5439

{ # Specification determining how headers are added to requests or responses.

5440

"headerName": "A String", # The name of the header.

5441

"headerValue": "A String", # The value of the header to add.

5442

"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.

5443

# The default value is false.

5444

},

5445

],

5446

"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) .

5451

# 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.

5452

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5453

},

5454

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5455

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

5456

"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.

5457

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5458

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5459

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5460

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5461

# The value must be between 1 and 255 characters.

5462

"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.

5463

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5464

# The default is set to false.

5465

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5466

# 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.

5467

# The value must be between 1 and 1024 characters.

5468

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5469

# 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.

5470

# The value must be between 1 and 1024 characters.

5471

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5472

# Supported values are:

5473

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5474

# - FOUND, which corresponds to 302.

5475

# - SEE_OTHER which corresponds to 303.

5476

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5477

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5478

"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.

5479

# The default is set to false.

5480

},

5481

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5482

"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.

5483

#

5484

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5485

"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.

5486

# The headerAction specified here take effect after headerAction specified under pathMatcher.

5487

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5488

{ # Specification determining how headers are added to requests or responses.

5489

"headerName": "A String", # The name of the header.

5490

"headerValue": "A String", # The value of the header to add.

5491

"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.

5492

# The default value is false.

5493

},

5494

],

5495

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5496

"A String",

5497

],

5498

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5499

{ # Specification determining how headers are added to requests or responses.

5500

"headerName": "A String", # The name of the header.

5501

"headerValue": "A String", # The value of the header to add.

5502

"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.

5503

# The default value is false.

5504

},

5505

],

5506

"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.

5511

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5512

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5513

"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 ..

5514

"A String",

5515

],

5516

"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.

5517

},

5518

],

5519

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5520

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5521

"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.

5522

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5523

{ # 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.

5524

"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.

5525

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

5526

"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

5527

"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.

5528

# Default is false.

5529

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5530

"A String",

5531

],

5532

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5533

"A String",

5534

],

5535

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5536

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5537

"A String",

5538

],

5539

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5540

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5541

"A String",

5542

],

5543

"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.

5544

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5545

"A String",

5546

],

5547

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5548

},

5549

"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.

5550

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5551

"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.

5552

"httpStatus": 42, # The HTTP status code used to abort the request.

5553

# The value must be between 200 and 599 inclusive.

5554

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5555

# The value must be between 0.0 and 100.0 inclusive.

5556

},

5557

"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.

5558

"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.

5559

"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.

5560

"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

5561

},

5562

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5563

# The value must be between 0.0 and 100.0 inclusive.

5564

},

5565

},

5566

"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.

5567

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5568

},

5569

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5570

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5571

"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.

5572

# 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.

5573

"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.

5574

"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

5575

},

5576

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5577

# - 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.

5578

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5579

# -

5580

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5581

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5582

# - 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.

5583

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5584

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5585

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5586

# - 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.

5591

# If not specified, will use the largest timeout among all backend services associated with the route.

5592

"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.

5593

"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

5594

},

5595

"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.

5596

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5597

# The value must be between 1 and 255 characters.

5598

"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.

5599

# The value must be between 1 and 1024 characters.

5600

},

5601

"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.

5602

# 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.

5603

{ # 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

5604

"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.

5605

"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.

5606

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5607

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5608

{ # Specification determining how headers are added to requests or responses.

5609

"headerName": "A String", # The name of the header.

5610

"headerValue": "A String", # The value of the header to add.

5611

"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.

5612

# The default value is false.

5613

},

5614

],

5615

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5616

"A String",

5617

],

5618

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5619

{ # Specification determining how headers are added to requests or responses.

5620

"headerName": "A String", # The name of the header.

5621

"headerValue": "A String", # The value of the header to add.

5622

"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.

5623

# The default value is false.

5624

},

5625

],

5626

"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) .

5631

# 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.

5632

# 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:

5637

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5638

# - compute/v1/projects/project/global/backendServices/backendService

5639

# - 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.

5640

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5641

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5642

# - compute.backendBuckets.use

5643

# - compute.backendServices.use

5644

"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.

5645

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5646

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5647

# The value must be between 1 and 255 characters.

5648

"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.

5649

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5650

# The default is set to false.

5651

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5652

# 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.

5653

# The value must be between 1 and 1024 characters.

5654

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5655

# 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.

5656

# The value must be between 1 and 1024 characters.

5657

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5658

# Supported values are:

5659

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5660

# - FOUND, which corresponds to 302.

5661

# - SEE_OTHER which corresponds to 303.

5662

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5663

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5664

"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.

5665

# The default is set to false.

5666

},

5667

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5668

"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.

5669

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

5670

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5671

{ # Specification determining how headers are added to requests or responses.

5672

"headerName": "A String", # The name of the header.

5673

"headerValue": "A String", # The value of the header to add.

5674

"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.

5675

# The default value is false.

5676

},

5677

],

5678

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5679

"A String",

5680

],

5681

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5682

{ # Specification determining how headers are added to requests or responses.

5683

"headerName": "A String", # The name of the header.

5684

"headerValue": "A String", # The value of the header to add.

5685

"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.

5686

# The default value is false.

5687

},

5688

],

5689

"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.

5694

"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.

5695

# 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.

5696

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5697

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5698

"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.

5699

"A String",

5700

],

5701

"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.

5702

# Only one of routeAction or urlRedirect must be set.

5703

"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

5704

"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.

5705

# Default is false.

5706

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5707

"A String",

5708

],

5709

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5710

"A String",

5711

],

5712

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5713

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5714

"A String",

5715

],

5716

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5717

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5718

"A String",

5719

],

5720

"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.

5721

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5722

"A String",

5723

],

5724

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5725

},

5726

"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.

5727

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5728

"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.

5729

"httpStatus": 42, # The HTTP status code used to abort the request.

5730

# The value must be between 200 and 599 inclusive.

5731

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5732

# The value must be between 0.0 and 100.0 inclusive.

5733

},

5734

"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.

5735

"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.

5736

"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.

5737

"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

5738

},

5739

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5740

# The value must be between 0.0 and 100.0 inclusive.

5741

},

5742

},

5743

"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.

5744

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5745

},

5746

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5747

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5748

"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.

5749

# 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.

5750

"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.

5751

"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

5752

},

5753

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5754

# - 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.

5755

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5756

# -

5757

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5758

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5759

# - 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.

5760

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5761

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5762

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5763

# - 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.

5768

# If not specified, will use the largest timeout among all backend services associated with the route.

5769

"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.

5770

"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

5771

},

5772

"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.

5773

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5774

# The value must be between 1 and 255 characters.

5775

"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.

5776

# The value must be between 1 and 1024 characters.

5777

},

5778

"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.

5779

# 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.

5780

{ # 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

5781

"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.

5782

"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.

5783

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5784

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5785

{ # Specification determining how headers are added to requests or responses.

5786

"headerName": "A String", # The name of the header.

5787

"headerValue": "A String", # The value of the header to add.

5788

"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.

5789

# The default value is false.

5790

},

5791

],

5792

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5793

"A String",

5794

],

5795

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5796

{ # Specification determining how headers are added to requests or responses.

5797

"headerName": "A String", # The name of the header.

5798

"headerValue": "A String", # The value of the header to add.

5799

"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.

5800

# The default value is false.

5801

},

5802

],

5803

"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) .

5808

# 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.

5809

# 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.

5814

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5815

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5816

# If urlRedirect is specified, service or routeAction must not be set.

5817

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5818

# The value must be between 1 and 255 characters.

5819

"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.

5820

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5821

# The default is set to false.

5822

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5823

# 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.

5824

# The value must be between 1 and 1024 characters.

5825

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5826

# 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.

5827

# The value must be between 1 and 1024 characters.

5828

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5829

# Supported values are:

5830

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5831

# - FOUND, which corresponds to 302.

5832

# - SEE_OTHER which corresponds to 303.

5833

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5834

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5835

"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.

5836

# 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.

5841

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5842

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5843

"description": "A String", # The short description conveying the intent of this routeRule.

5844

# The description can have a maximum length of 1024 characters.

5845

"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.

5846

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5847

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5848

{ # Specification determining how headers are added to requests or responses.

5849

"headerName": "A String", # The name of the header.

5850

"headerValue": "A String", # The value of the header to add.

5851

"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.

5852

# The default value is false.

5853

},

5854

],

5855

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5856

"A String",

5857

],

5858

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5859

{ # Specification determining how headers are added to requests or responses.

5860

"headerName": "A String", # The name of the header.

5861

"headerValue": "A String", # The value of the header to add.

5862

"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.

5863

# The default value is false.

5864

},

5865

],

5866

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5872

"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.

5873

# fullPathMatch must be between 1 and 1024 characters.

5874

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5875

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5876

{ # matchRule criteria for request header matches.

5877

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5878

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5879

"headerName": "A String", # The name of the HTTP header to match.

5880

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5881

# For matching a request's method, use the headerName ":method".

5882

"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.

5883

# The default setting is false.

5884

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5885

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5886

"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.

5887

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5888

"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.

5889

# For example for a range [-5, 0]

5890

# - -3 will match.

5891

# - 0 will not match.

5892

# - 0.25 will not match.

5893

# - -3someString will not match.

5894

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5895

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5896

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5897

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5898

},

5899

"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

5900

# 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.

5901

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5902

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5903

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5904

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5905

},

5906

],

5907

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5908

# The default value is false.

5909

# ignoreCase must not be used with regexMatch.

5910

"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.

5911

# 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.

5912

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5913

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5914

{ # 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.

5915

# 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.

5916

# 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.

5917

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5918

# This list must not be empty and can have at the most 64 entries.

5919

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5920

"name": "A String", # Name of metadata label.

5921

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5922

"value": "A String", # The value of the label must match the specified value.

5923

# value can have a maximum length of 1024 characters.

5924

},

5925

],

5926

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5927

# Supported values are:

5928

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5929

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5930

},

5931

],

5932

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5933

# The value must be between 1 and 1024 characters.

5934

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5935

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5936

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5937

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5938

# Only one of presentMatch, exactMatch or regexMatch must be set.

5939

"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.

5940

"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.

5941

# Only one of presentMatch, exactMatch or regexMatch must be set.

5942

"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

5943

# Only one of presentMatch, exactMatch or regexMatch must be set.

5944

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5945

},

5946

],

5947

"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

5948

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5949

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5950

},

5951

],

5952

"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.

5953

# 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.

5954

# 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.

5955

"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.

5956

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5957

"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

5958

"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.

5959

# Default is false.

5960

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5961

"A String",

5962

],

5963

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5964

"A String",

5965

],

5966

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5967

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5968

"A String",

5969

],

5970

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5971

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5972

"A String",

5973

],

5974

"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.

5975

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5976

"A String",

5977

],

5978

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5979

},

5980

"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.

5981

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5982

"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.

5983

"httpStatus": 42, # The HTTP status code used to abort the request.

5984

# The value must be between 200 and 599 inclusive.

5985

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5986

# The value must be between 0.0 and 100.0 inclusive.

5987

},

5988

"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.

5989

"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.

5990

"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.

5991

"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

5992

},

5993

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5994

# The value must be between 0.0 and 100.0 inclusive.

5995

},

5996

},

5997

"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.

5998

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5999

},

6000

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

6001

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6002

"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.

6003

# 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.

6004

"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.

6005

"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

6006

},

6007

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6008

# - 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.

6009

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6010

# -

6011

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6012

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6013

# - 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.

6014

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6015

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6016

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6017

# - 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.

6022

# If not specified, will use the largest timeout among all backend services associated with the route.

6023

"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.

6024

"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

6025

},

6026

"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.

6027

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6028

# The value must be between 1 and 255 characters.

6029

"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.

6030

# The value must be between 1 and 1024 characters.

6031

},

6032

"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.

6033

# 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.

6034

{ # 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

6035

"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.

6036

"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.

6037

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

6038

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6039

{ # Specification determining how headers are added to requests or responses.

6040

"headerName": "A String", # The name of the header.

6041

"headerValue": "A String", # The value of the header to add.

6042

"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.

6043

# The default value is false.

6044

},

6045

],

6046

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6047

"A String",

6048

],

6049

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6050

{ # Specification determining how headers are added to requests or responses.

6051

"headerName": "A String", # The name of the header.

6052

"headerValue": "A String", # The value of the header to add.

6053

"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.

6054

# The default value is false.

6055

},

6056

],

6057

"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) .

6062

# 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.

6063

# 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.

6068

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6069

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6070

# If urlRedirect is specified, service or routeAction must not be set.

6071

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6072

# The value must be between 1 and 255 characters.

6073

"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.

6074

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6075

# The default is set to false.

6076

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6077

# 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.

6078

# The value must be between 1 and 1024 characters.

6079

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6080

# 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.

6081

# The value must be between 1 and 1024 characters.

6082

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6083

# Supported values are:

6084

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6085

# - FOUND, which corresponds to 302.

6086

# - SEE_OTHER which corresponds to 303.

6087

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6088

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6089

"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.

6090

# 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.

6097

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6098

"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.

6099

{ # Message for the expected URL mappings.

6100

"description": "A String", # Description of this test case.

6101

"host": "A String", # Host portion of the URL.

6102

"path": "A String", # Path portion of the URL.

6103

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

6104

},

6105

],

6106

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}

Returns:

An object of the form:

6112

6113

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

6114

"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.

6119

"testFailures": [

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6120

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

6121

"actualService": "A String",

6122

"expectedService": "A String",

6123

"host": "A String",

6124

"path": "A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6125

},

6126

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

6127

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Craig Citro